wire-schema/com.squareup.wire.schema/EventListener

EventListener

abstract class EventListener

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

The events' order is as follows:

  • runStart

  • loadSchemaStart

  • loadSchemaSuccess

  • treeShakeStart

  • treeShakeEnd

  • moveTypesStart

  • moveTypesEnd

  • schemaHandlersStart // Looping over all handlers.

    • schemaHandlerStart

    • schemaHandlerEnd

  • schemaHandlersEnd

  • runSuccess / runFailed

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
fun interface Factory : Serializable

Functions

Link copied to clipboard
open fun loadSchemaStart()

Invoked prior to loading the Protobuf schema. this includes parsing .proto files, and resolving all referenced types.

Link copied to clipboard
open fun loadSchemaSuccess(schema: Schema)

Invoked after having loaded the Protobuf schema. this includes parsing .proto files, and resolving all referenced types.

Link copied to clipboard
open fun moveTypesEnd(refactoredSchema: Schema, moves: List<TypeMover.Move>)

Invoked after having refactored the Protobuf schema by applying the moves.

Link copied to clipboard
open fun moveTypesStart(schema: Schema, moves: List<TypeMover.Move>)

Invoked prior to refactoring the Protobuf schema by applying the moves.

Link copied to clipboard
open fun runFailed(errors: List<String>)
Link copied to clipboard
open fun runStart(wireRun: WireRun)

Invoked prior to Wire starting.

Link copied to clipboard
open fun runSuccess(wireRun: WireRun)

Invoked after Wire has executed all operations.

Link copied to clipboard
open fun schemaHandlerEnd(schemaHandler: SchemaHandler, emittingRules: EmittingRules)

Invoked after a schema handler has finished.

Link copied to clipboard
open fun schemaHandlersEnd()

Invoked after having executed all schema handler.

Link copied to clipboard
open fun schemaHandlersStart()

Invoked prior to executing all schema handler.

Link copied to clipboard
open fun schemaHandlerStart(schemaHandler: SchemaHandler, emittingRules: EmittingRules)

Invoked prior a schema handler starting.

Link copied to clipboard
open fun treeShakeEnd(refactoredSchema: Schema, pruningRules: PruningRules)

Invoked after having refactored the Protobuf schema by tree-shaking it using the pruning rules.

Link copied to clipboard
open fun treeShakeStart(schema: Schema, pruningRules: PruningRules)

Invoked prior to refactoring the Protobuf schema by tree-shaking it using the pruning rules.