wire-schema/com.squareup.wire.schema/MessageType

MessageType

data class MessageType(val type: ProtoType, val location: Location, val documentation: String, val name: String, val declaredFields: List<Field>, val extensionFields: MutableList<Field>, val oneOfs: List<OneOf>, val nestedTypes: List<Type>, val nestedExtendList: List<Extend>, val extensionsList: List<Extensions>, reserveds: List<Reserved>, val options: Options, val syntax: Syntax) : Type

Constructors

MessageType

constructor(type: ProtoType, location: Location, documentation: String, name: String, declaredFields: List<Field>, extensionFields: MutableList<Field>, oneOfs: List<OneOf>, nestedTypes: List<Type>, nestedExtendList: List<Extend>, extensionsList: List<Extensions>, reserveds: List<Reserved>, options: Options, syntax: Syntax)

Types

Companion

object Companion

Properties

declaredFields

val declaredFields: List<Field>

documentation

open override val documentation: String

extensionFields

val extensionFields: MutableList<Field>

extensionsList

val extensionsList: List<Extensions>

fields

@get:JvmName(name = "fields")

val fields: List<Field>

fieldsAndOneOfFields

val fieldsAndOneOfFields: List<Field>

isDeprecated

val isDeprecated: Boolean

location

open override val location: Location

name

open override val name: String

nestedExtendList

open override val nestedExtendList: List<Extend>

nestedTypes

open override val nestedTypes: List<Type>

oneOfs

val oneOfs: List<OneOf>

options

open override val options: Options

requiredFields

val requiredFields: List<Field>

syntax

open override val syntax: Syntax

type

open override val type: ProtoType

Functions

addExtensionFields

fun addExtensionFields(fields: List<Field>)

extensionField

fun extensionField(qualifiedName: String): Field?

Returns the field with the qualified name qualifiedName, or null if this type has no such field.

extensionFieldsMap

fun extensionFieldsMap(): Map<String, Field>

field

fun field(tag: Int): Field?

Returns the field tagged tag, or null if this type has no such field.

fun field(name: String): Field?

Returns the field named name, or null if this type has no such field.

linkMembers

open override fun linkMembers(linker: Linker)

linkOptions

open override fun linkOptions(linker: Linker, syntaxRules: SyntaxRules, validate: Boolean)

oneOf

fun oneOf(name: String): OneOf?

Returns the oneOf named name, or null if this type has no such oneOf.

retainAll

open override fun retainAll(schema: Schema, markSet: MarkSet): Type?

retainLinked

open override fun retainLinked(linkedTypes: Set<ProtoType>, linkedFields: Set<Field>): Type?

Returns a copy of this containing only the types in linkedTypes and extensions in linkedFields, or null if that set is empty. This will return an EnclosingType if it is itself not linked, but its nested types are linked.

toElement

fun toElement(): MessageElement

typesAndNestedTypes

fun typesAndNestedTypes(): List<Type>

Returns all types and subtypes which are linked to the type.

validate

open override fun validate(linker: Linker, syntaxRules: SyntaxRules)