wire-schema/com.squareup.wire.schema/Linker

Linker

Links local field types and option types to the corresponding declarations.

Constructors

constructor(loader: Loader, errors: ErrorCollector, permitPackageCycles: Boolean, loadExhaustively: Boolean, opaqueTypes: List<ProtoType>)

constructor(loader: Loader, errors: ErrorCollector, permitPackageCycles: Boolean, loadExhaustively: Boolean)

Properties

errors

val errors: ErrorCollector

Errors accumulated by this load.

loadExhaustively

val loadExhaustively: Boolean

Functions

addType

fun addType(protoType: ProtoType, type: Type)

Adds type.

dereference

fun dereference(protoType: ProtoType, field: String): Field?

Returns the field named field on the message type of protoType.

get

fun get(protoType: ProtoType): Type?

Returns the type or null if it doesn't exist.

getForOptions

fun getForOptions(protoType: ProtoType): Type?

Returns the type or null if it doesn't exist. Before this returns it ensures members are linked so that options may dereference them.

link

fun link(sourceProtoFiles: Iterable<ProtoFile>): Schema

Link all features of all files in sourceProtoFiles to create a schema. This will also partially link any imported files necessary.

request

fun request(field: Field)

Mark a field as used in an option so its file is retained in the schema.

resolve

fun <T> resolve(name: String, map: Map<String, T>): T?

resolveContext

fun resolveContext(): String

resolveMessageType

fun resolveMessageType(name: String): ProtoType

Returns the type name for the relative or fully-qualified name name.

resolveType

fun resolveType(name: String): ProtoType

Returns the type name for the scalar, relative or fully-qualified name name.

validateEnumConstantNameUniqueness

fun validateEnumConstantNameUniqueness(nestedTypes: Iterable<Type>)

validateFields

fun validateFields(fields: Iterable<Field>, reserveds: List<Reserved>, syntaxRules: SyntaxRules)

Validate that the tags of fields are unique and in range, that proto3 message cannot reference proto2 enums.

validateImportForPath

fun validateImportForPath(location: Location, requiredImport: String)

validateImportForType

fun validateImportForType(location: Location, type: ProtoType)

withContext

fun withContext(context: Any): Linker

Returns a new linker that uses context to resolve type names and report errors.