com.google.api.tools.framework.model

Interface Processor

All Known Implementing Classes:

Linter, Merger, Normalizer, Resolver

public interface Processor

Interface for a processor which performs an analysis or transformation task on the model.

Method Summary

Modifier and Type	Method and Description
com.google.inject.Key<?>	establishes() The stage this processor establishes if operation successfully finishes.
com.google.common.collect.ImmutableList<com.google.inject.Key<?>>	requires() The list of stages this processor needs for its operations.
boolean	run(Model model) Runs this processor.

Method Detail

requires

com.google.common.collect.ImmutableList<com.google.inject.Key<?>> requires()

The list of stages this processor needs for its operations. Stages are attached as attributes on the Model. A stage may or may not be associated with actual data of the type of the parameter of the key.

establishes

com.google.inject.Key<?> establishes()

The stage this processor establishes if operation successfully finishes. The processor is responsible to attach the stage key to the model.

run

boolean run(Model model)

Runs this processor. It is guaranteed that the requires() stages are established before this method is called via Model.establishStage(Key). The method should return true if processing successfully finished and the given establishes() key has been attached to the model. Any errors, warnings, and hints during processing should be attached to the model via Model.getDiagCollector().