WireLogger

interface WireLogger

Logger class used by WireRun and com.squareup.wire.schema.Target.SchemaHandler to log information related to processing the protobuf Schema.

Inheritors

EmptyWireLogger

Types

Link copied to clipboard
object Companion
Link copied to clipboard
fun interface Factory : Serializable

Implementations of this interface must have a no-arguments public constructor.

Functions

Link copied to clipboard
abstract fun artifactHandled(outputPath: Path, qualifiedName: String, targetName: String)

This is called when an artifact is handled by a com.squareup.wire.schema.Target.SchemaHandler.

Link copied to clipboard
abstract fun artifactSkipped(type: ProtoType, targetName: String)

This is called when an artifact has been passed down to a com.squareup.wire.schema.Target.SchemaHandler but has been skipped. This is useful for dry-runs.

Link copied to clipboard
abstract fun unusedExcludesInTarget(unusedExcludes: Set<String>)

This is called if some excludes values have not been used by the target they were defined in. Note that excludes should contain package names (suffixed with .*) and type names only. It should not contain member names, nor file paths. Unused excludes can happen if the referenced type or service isn't part of the parsed and pruned schema model, or has already been consumed by another preceding target.

Link copied to clipboard
abstract fun unusedIncludesInTarget(unusedIncludes: Set<String>)

This is called if some includes values have not been used by the target they were defined in. Note that includes should contain package names (suffixed with .*) and type names only. It should not contain member names, nor file paths. Unused includes can happen if the referenced type or service isn't part of the parsed and pruned schema model, or has already been consumed by another preceding target.

Link copied to clipboard
abstract fun unusedPrunes(unusedPrunes: Set<String>)

This is called if some prune values have not been used when Wire pruned the schema model. Note that prune should contain package names (suffixed with .*), type names, and member names only. It should not contain file paths. Unused prunes can happen if the referenced type or service isn't part of any .proto files defined in either sourcePath or protoPath, or if a broader prune value is already defined.

Link copied to clipboard
abstract fun unusedRoots(unusedRoots: Set<String>)

This is called if some root values have not been used when Wire pruned the schema model. Note that root should contain package names (suffixed with .*), type names, and member names only. It should not contain file paths. Unused roots can happen if the referenced type or service isn't part of any .proto files defined in either sourcePath or protoPath, or if a broader root value is already defined.