com.google.api.tools.framework.aspects.documentation

Class DocumentationConfigAspect

java.lang.Object

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

com.google.api.tools.framework.aspects.RuleBasedConfigAspect<com.google.api.DocumentationRule,ElementDocumentationAttribute>

com.google.api.tools.framework.aspects.documentation.DocumentationConfigAspect

All Implemented Interfaces:

ConfigAspect

public class DocumentationConfigAspect
extends RuleBasedConfigAspect<com.google.api.DocumentationRule,ElementDocumentationAttribute>

Configuration aspect for documentation.

Method Summary

Modifier and Type	Method and Description
protected void	addToRuleBuilder(com.google.api.Service.Builder builder, java.lang.String selector, ElementDocumentationAttribute attr) Adds a rule back to the rule builder, specialized for the given selector.
protected void	clearRuleBuilder(com.google.api.Service.Builder builder) Clears the rule builder during normalization.
static DocumentationConfigAspect	create(Model model)
protected ElementDocumentationAttribute	evaluate(ProtoElement element, com.google.api.DocumentationRule rule, boolean isFromIdl) Evaluates the rule w.r.t.
protected com.google.api.DocumentationRule	fromIdlLayer(ProtoElement element) Attempts to synthesize the rule from the IDL, e.g.
protected boolean	isApplicable(ProtoElement element) Predicate determining whether a rule of the aspect is applicable to the element.
java.util.List<java.lang.Class<? extends ConfigAspect>>	mergeDependencies() Returns an empty list since this aspect does not depend on any other aspects.
void	startMerging() Default implementation of starting merge; does nothing.
void	startNormalization(com.google.api.Service.Builder builder) Default implementation of starting normalization; does nothing.

Methods inherited from class com.google.api.tools.framework.aspects.RuleBasedConfigAspect

endMerging, merge, normalize

Methods inherited from class com.google.api.tools.framework.aspects.ConfigAspectBase

asDiagCollector, endLinting, endNormalization, error, getAspectName, getDocumentation, getDocumentationTitle, getLintRuleNames, getLocationInConfig, getLocationOfRepeatedFieldInConfig, getModel, lint, lintWarning, registerLintRule, registerLintRuleName, startLinting, warning

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DocumentationConfigAspect create(Model model)

mergeDependencies

public java.util.List<java.lang.Class<? extends ConfigAspect>> mergeDependencies()

Returns an empty list since this aspect does not depend on any other aspects.

isApplicable

protected boolean isApplicable(ProtoElement element)

Description copied from class: RuleBasedConfigAspect

Predicate determining whether a rule of the aspect is applicable to the element.

Specified by:

isApplicable in class RuleBasedConfigAspect<com.google.api.DocumentationRule,ElementDocumentationAttribute>

startMerging

public void startMerging()

Description copied from class: ConfigAspectBase

Default implementation of starting merge; does nothing.

Specified by:

startMerging in interface ConfigAspect

Overrides:

startMerging in class ConfigAspectBase

fromIdlLayer

@Nullable
protected com.google.api.DocumentationRule fromIdlLayer(ProtoElement element)

Description copied from class: RuleBasedConfigAspect

Attempts to synthesize the rule from the IDL, e.g. via an annotation. This is called if there is no matching rule found for a given element. By default, returns null.

Overrides:

fromIdlLayer in class RuleBasedConfigAspect<com.google.api.DocumentationRule,ElementDocumentationAttribute>

evaluate

protected ElementDocumentationAttribute evaluate(ProtoElement element,
                                                 com.google.api.DocumentationRule rule,
                                                 boolean isFromIdl)

Description copied from class: RuleBasedConfigAspect

Evaluates the rule w.r.t. the given element and returns the attribute which should be attached to the element. May add errors on the element's model, and may return null if evaluation fails.

Specified by:

evaluate in class RuleBasedConfigAspect<com.google.api.DocumentationRule,ElementDocumentationAttribute>

startNormalization

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

Description copied from class: ConfigAspectBase

Default implementation of starting normalization; does nothing.

Specified by:

startNormalization in interface ConfigAspect

Overrides:

startNormalization in class RuleBasedConfigAspect<com.google.api.DocumentationRule,ElementDocumentationAttribute>

clearRuleBuilder

protected void clearRuleBuilder(com.google.api.Service.Builder builder)

Description copied from class: RuleBasedConfigAspect

Clears the rule builder during normalization.

Specified by:

clearRuleBuilder in class RuleBasedConfigAspect<com.google.api.DocumentationRule,ElementDocumentationAttribute>

addToRuleBuilder

protected void addToRuleBuilder(com.google.api.Service.Builder builder,
                                java.lang.String selector,
                                ElementDocumentationAttribute attr)

Description copied from class: RuleBasedConfigAspect

Adds a rule back to the rule builder, specialized for the given selector.

Specified by:

addToRuleBuilder in class RuleBasedConfigAspect<com.google.api.DocumentationRule,ElementDocumentationAttribute>