com.google.api.tools.framework.processors.linter

Class Linter

java.lang.Object

com.google.api.tools.framework.processors.linter.Linter

All Implemented Interfaces:

Processor

public class Linter
extends java.lang.Object
implements Processor

Linter for IDL and service config. Delegates work to config aspects.

Constructor Summary

Constructors

Constructor and Description
Linter()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Linter

public Linter()

Method Detail

requires

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

Description copied from interface: Processor

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.

Specified by:

requires in interface Processor

establishes

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

Description copied from interface: Processor

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

Specified by:

establishes in interface Processor

run

public boolean run(Model model)

Description copied from interface: Processor

Runs this processor. It is guaranteed that the Processor.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 Processor.establishes() key has been attached to the model. Any errors, warnings, and hints during processing should be attached to the model via Model.getDiagCollector().

Specified by:

run in interface Processor