com.google.api.tools.framework.aspects

Class ConfigAspectBase

java.lang.Object

com.google.api.tools.framework.aspects.ConfigAspectBase

All Implemented Interfaces:

ConfigAspect

Direct Known Subclasses:

ControlConfigAspect, NamingConfigAspect, RuleBasedConfigAspect, ServiceControlConfigAspect, SystemConfigAspect, VersionConfigAspect

public abstract class ConfigAspectBase
extends java.lang.Object
implements ConfigAspect

Base class for implementing config aspects.

All aspect implementations must extend this class or it's descendants instead of directly implementing the interface ConfigAspect. Errors and warnings must be reported using the methods on this class instead of via the model.

Please observe that according to rules described in ConfigAspect, during the merging state, only essential validation issues should be reported as errors, but not style violations. It is recommended to use the LintRule mechanism for style violations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigAspectBase(Model model, java.lang.String aspectName) Initializes this base class.

Method Summary

Modifier and Type	Method and Description
DiagCollector	asDiagCollector() Return a view of this aspect as a diag collector.
void	endLinting() Default implementation ending linting.
void	endMerging() Default implementation ending merging; does nothing.
void	endNormalization(com.google.api.Service.Builder builder) Default implementation of ending normalization; does nothing.
void	error(java.lang.Object elementOrLocation, java.lang.String message, java.lang.Object... params) Helper for subclasses to report an error.
java.lang.String	getAspectName() Returns the string identifying the aspect in diagnosis.
java.lang.String	getDocumentation(ProtoElement element) Default implementation of aspect documentation.
java.lang.String	getDocumentationTitle(ProtoElement element) Default implementation of aspect documentation title.
java.util.Set<java.lang.String>	getLintRuleNames() Returns the set of all style rule names related to this aspect.
Location	getLocationInConfig(com.google.protobuf.Message message, java.lang.String fieldName) Returns the service config file location of the given named field in the (sub)message.
Location	getLocationOfRepeatedFieldInConfig(com.google.protobuf.Message message, java.lang.String fieldName, java.lang.Object elementKey) Returns the service config file location of the given named field in the (sub)message.
Model	getModel() Returns the model to which the aspect is linked.
void	lint(ProtoElement elem) Default implementation of linting an element.
void	lintWarning(java.lang.String ruleName, java.lang.Object elementOrLocation, java.lang.String message, java.lang.Object... params) Helper for subclasses to report a linter warning.
void	merge(ProtoElement elem) Default implementation for merging an element; does nothing.
void	normalize(ProtoElement element, com.google.api.Service.Builder builder) Default implementation to normalize an element; does nothing.
<E extends Element> void	registerLintRule(LintRule<E> rule) Registers a linting rule with this aspect.
void	registerLintRuleName(java.lang.String... names) Registers name of a lint rule.
void	startLinting() Default implementation of start linting; does nothing.
void	startMerging() Default implementation of starting merge; does nothing.
void	startNormalization(com.google.api.Service.Builder builder) Default implementation of starting normalization; does nothing.
void	warning(java.lang.Object elementOrLocation, java.lang.String message, java.lang.Object... params) Helper for subclasses to report a warning.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.api.tools.framework.model.ConfigAspect

mergeDependencies

Constructor Detail

ConfigAspectBase

protected ConfigAspectBase(Model model,
                           java.lang.String aspectName)

Initializes this base class. Takes a string which is used to identify the aspect in diagnosis.

Method Detail

getModel

public Model getModel()

Returns the model to which the aspect is linked.

getAspectName

public java.lang.String getAspectName()

Description copied from interface: ConfigAspect

Returns the string identifying the aspect in diagnosis.

Specified by:

getAspectName in interface ConfigAspect

getLintRuleNames

public java.util.Set<java.lang.String> getLintRuleNames()

Description copied from interface: ConfigAspect

Returns the set of all style rule names related to this aspect.

Specified by:

getLintRuleNames in interface ConfigAspect

registerLintRule

public <E extends Element> void registerLintRule(LintRule<E> rule)

Registers a linting rule with this aspect. The type of the rule can be either a proto element or, for top-level scoped issues, the model itself. All registered rules are run automatically by this class.

registerLintRuleName

public void registerLintRuleName(java.lang.String... names)

Registers name of a lint rule. Should be used for all rule names used in lintWarning(String, Object, String, Object...) to enable suppression. Does not need to be used for rules using the registerLintRule(LintRule) mechanism.

startMerging

public void startMerging()

Default implementation of starting merge; does nothing.

Specified by:

startMerging in interface ConfigAspect

merge

public void merge(ProtoElement elem)

Default implementation for merging an element; does nothing.

Specified by:

merge in interface ConfigAspect

endMerging

public void endMerging()

Default implementation ending merging; does nothing.

Specified by:

endMerging in interface ConfigAspect

startLinting

public void startLinting()

Default implementation of start linting; does nothing.

Specified by:

startLinting in interface ConfigAspect

lint

public void lint(ProtoElement elem)

Default implementation of linting an element. This runs all registered style rules for the element's type.

If you override this method, be sure to call super.

Specified by:

lint in interface ConfigAspect

endLinting

public void endLinting()

Default implementation ending linting. This runs all style rules registered for the model (top-level scope).

If you override this method, be sure to call super.

Specified by:

endLinting in interface ConfigAspect

startNormalization

public void startNormalization(com.google.api.Service.Builder builder)

Default implementation of starting normalization; does nothing.

Specified by:

startNormalization in interface ConfigAspect

normalize

public void normalize(ProtoElement element,
                      com.google.api.Service.Builder builder)

Default implementation to normalize an element; does nothing.

Specified by:

normalize in interface ConfigAspect

endNormalization

public void endNormalization(com.google.api.Service.Builder builder)

Default implementation of ending normalization; does nothing.

Specified by:

endNormalization in interface ConfigAspect

getDocumentationTitle

public java.lang.String getDocumentationTitle(ProtoElement element)

Default implementation of aspect documentation title. Returns null, indicating the aspect is not documented.

Specified by:

getDocumentationTitle in interface ConfigAspect

getDocumentation

public java.lang.String getDocumentation(ProtoElement element)

Default implementation of aspect documentation. Returns null, indicating the aspect is not documented.

Specified by:

getDocumentation in interface ConfigAspect

error

public void error(java.lang.Object elementOrLocation,
                  java.lang.String message,
                  java.lang.Object... params)

Helper for subclasses to report an error.

warning

public void warning(java.lang.Object elementOrLocation,
                    java.lang.String message,
                    java.lang.Object... params)

Helper for subclasses to report a warning.

lintWarning

public void lintWarning(java.lang.String ruleName,
                        java.lang.Object elementOrLocation,
                        java.lang.String message,
                        java.lang.Object... params)

Helper for subclasses to report a linter warning. Each such warning must have a name so the user can suppress it. The name is relative to the aspect name.

This method should usually not be directly called. Instead, use the LintRule mechanism.

getLocationInConfig

public Location getLocationInConfig(com.google.protobuf.Message message,
                                    java.lang.String fieldName)

Returns the service config file location of the given named field in the (sub)message.

getLocationOfRepeatedFieldInConfig

public Location getLocationOfRepeatedFieldInConfig(com.google.protobuf.Message message,
                                                   java.lang.String fieldName,
                                                   java.lang.Object elementKey)

Returns the service config file location of the given named field in the (sub)message. The key identifies the key of the map. For repeated fields, the element key is a zero-based index. Returns SimpleLocation.TOPLEVEL if the location is not known.

asDiagCollector

public DiagCollector asDiagCollector()

Return a view of this aspect as a diag collector. This allows for abstracting the aspect to make code better testable.