wire-schema/com.squareup.wire.schema

Package-level declarations

Types

data class AdapterConstant(val javaClassName: ClassName, val kotlinClassName: ClassName, val memberName: String)

A constant field that identifies a ProtoAdapter. This should be a string like like com.squareup.dinosaurs.Dinosaur#ADAPTER with a fully qualified class name, a #, and a field name.

ClaimedDefinitions

class ClaimedDefinitions

ClaimedDefinitions tracks handled objects: Types, Services, and Fields. A SchemaHandler is to first check if an object has already been claimed; if yes, it is not to handle it. Otherwise, the SchemaHandler is to handle the object and claim it. It is an error for a SchemaHandler to handle an object which has already been claimed.

ClaimedPaths

class ClaimedPaths

ClaimedPaths tracks generated files' Paths. Schema handlers who generate files are to claim each generated file's path. It is an error to generate different Types or Services to the same file and ClaimedPaths will throw when generation conflicts happen.

CoreLoader

expect object CoreLoader : Loader

A specific Loader which loads Wire's runtime proto files such as google/protobuf/descriptor.proto or wire/extensions.proto.

actual object CoreLoader : Loader

A loader that can only load built-in .proto files:

actual object CoreLoader : Loader

EmittingRules

class EmittingRules

A set of rules that describes which types to generate.

EmptyWireLogger

class EmptyWireLogger : WireLogger

EmptyWireLoggerFactory

class EmptyWireLoggerFactory : WireLogger.Factory

EnclosingType

data class EnclosingType(val location: Location, val type: ProtoType, val name: String, val documentation: String, val nestedTypes: List<Type>, val nestedExtendList: List<Extend>, val syntax: Syntax) : Type

An empty type which only holds nested types.

EnumConstant

data class EnumConstant(val location: Location, val name: String, val tag: Int, val documentation: String, val options: Options)

EnumType

data class EnumType(val type: ProtoType, val location: Location, val documentation: String, val name: String, val constants: List<EnumConstant>, reserveds: List<Reserved>, val options: Options, val syntax: Syntax) : Type

ErrorCollector

class ErrorCollector

Collects errors to be reported as a batch. Errors include both a detail message plus context of where they occurred within the schema.

EventListener

abstract class EventListener

Listener for metrics events. Extend this class to monitor WireRun and all schema handlers involved in the Protobuf schema manipulation.

Extend

data class Extend(val location: Location, val documentation: String, val name: String, val fields: List<Field>)

Extensions

data class Extensions(val location: Location, val documentation: String, val values: List<Any>)

Field

data class Field(val namespaces: List<String>, val location: Location, val label: Field.Label?, val name: String, val documentation: String, val tag: Int, val default: String?, elementType: String, val options: Options, val isExtension: Boolean, val isOneOf: Boolean, val declaredJsonName: String?)

LinkedOptionEntry

data class LinkedOptionEntry(val optionElement: OptionElement, val protoMember: ProtoMember, val value: Any?)

Linker

class Linker

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

Loader

interface Loader

Loads other files as needed by their import path.

Location

data class Location(val base: String, val path: String, val line: Int = -1, val column: Int = -1)

Locates a .proto file, or a position within a .proto file, on the file system. This includes a base directory or a .jar file, and a path relative to that base.

MarkSet

class MarkSet(val pruningRules: PruningRules)

A mark set is used in three phases:

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

Multimap

expect interface Multimap<K, V>

actual interface Multimap<K, V>

actual typealias Multimap<K, V> = com.google.common.collect.Multimap<K, V>

actual interface Multimap<K, V>

OneOf

data class OneOf(val name: String, val documentation: String, val fields: List<Field>, val location: Location, val options: Options)

Options

class Options(optionType: ProtoType, optionElements: List<OptionElement>)

A set of options declared on a message declaration, field declaration, enum declaration, enum constant declaration, service declaration, RPC method declaration, or proto file declaration. Options values may be arbitrary protocol buffer messages, but must be valid protocol buffer messages.

Profile

expect class Profile(profileFiles: List<ProfileFileElement> = emptyList())

actual class Profile(profileFiles: List<ProfileFileElement>)

Describes how to map .proto to .java. A single repository of .proto files may have multiple profiles; for example a project may target both Android and Java.

actual class Profile(profileFiles: List<ProfileFileElement>)

ProfileLoader

interface ProfileLoader

ProtoFile

data class ProtoFile(val location: Location, val imports: List<String>, val publicImports: List<String>, val packageName: String?, val types: List<Type>, val services: List<Service>, val extendList: List<Extend>, val options: Options, val syntax: Syntax?)

ProtoMember

class ProtoMember

Identifies a field, enum or RPC on a declaring type. Members are encoded as strings containing a type name, a hash, and a member name, like squareup.dinosaurs.Dinosaur#length_meters.

ProtoType

class ProtoType

Names a protocol buffer message, enumerated type, service, map, or a scalar. This class models a fully-qualified name using the protocol buffer package.

Pruner

class Pruner(schema: Schema, pruningRules: PruningRules)

Creates a new schema that contains only the types selected by the pruning rules, including their transitive dependencies.

PruningRules

class PruningRules

A set of rules that describes which types and members to retain and which to remove.

Reserved

data class Reserved(val location: Location, val documentation: String, val values: List<Any>)

Rpc

data class Rpc(val location: Location, val name: String, val documentation: String, requestTypeElement: String, responseTypeElement: String, val requestStreaming: Boolean, val responseStreaming: Boolean, val options: Options)

Schema

class Schema

A collection of .proto files that describe a set of messages. A schema is linked: each field's type name is resolved to the corresponding type definition.

SchemaException

class SchemaException(errors: List<String>) : RuntimeException

SchemaHandler

abstract class SchemaHandler

A SchemaHandlers Schema!

SchemaLoader

expect class SchemaLoader(fileSystem: FileSystem) : Loader, ProfileLoader

Load proto files and their transitive dependencies and parse them. Keep track of which files were loaded from where so that we can use that information later when deciding what to generate.

actual class SchemaLoader(fileSystem: FileSystem) : Loader, ProfileLoader

Service

data class Service(val type: ProtoType, val location: Location, val documentation: String, val name: String, val rpcs: List<Rpc>, val options: Options)

SyntaxRules

interface SyntaxRules

A set of rules which defines schema requirements for a specific Syntax.

Target

abstract class Target : Serializable

Type

sealed class Type

WireRun

class WireRun(val sourcePath: List<Location>, val protoPath: List<Location> = listOf(), val treeShakingRoots: List<String> = listOf("*"), val treeShakingRubbish: List<String> = listOf(), val moves: List<TypeMover.Move> = listOf(), val sinceVersion: String? = null, val untilVersion: String? = null, val onlyVersion: String? = null, val targets: List<Target>, val modules: Map<String, WireRun.Module> = emptyMap(), val permitPackageCycles: Boolean = false, val escapeKotlinKeywords: Boolean = false, val eventListeners: List<EventListener> = listOf(), val rejectUnusedRootsOrPrunes: Boolean = true, val opaqueTypes: List<String> = listOf())

An invocation of the Wire compiler. Each invocation performs the following operations:

Properties

WIRE_RUNTIME_JAR

const val WIRE_RUNTIME_JAR: String

A special base directory used for Wire's built-in .proto files.

Functions

isWireRuntimeProto

fun isWireRuntimeProto(location: Location): Boolean

fun isWireRuntimeProto(path: String): Boolean

Returns true if path is bundled in the wire runtime.

newEventListenerFactory

fun newEventListenerFactory(eventListenerFactoryClass: String): EventListener.Factory

Create and return an instance of EventListener.Factory.

newLoggerFactory

fun newLoggerFactory(loggerFactoryClass: String): WireLogger.Factory

Create and return an instance of WireLogger.Factory.