com.google.api.tools.framework.aspects

Class RuleBasedConfigAspect<RuleType extends com.google.protobuf.Message,AttributeType>

java.lang.Object

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

com.google.api.tools.framework.aspects.RuleBasedConfigAspect<RuleType,AttributeType>

All Implemented Interfaces:

ConfigAspect

Direct Known Subclasses:

AuthConfigAspect, ContextConfigAspect, DocumentationConfigAspect, HttpConfigAspect, SystemParameterConfigAspect, UsageConfigAspect

public abstract class RuleBasedConfigAspect<RuleType extends com.google.protobuf.Message,AttributeType>
extends ConfigAspectBase

Base class for implementing simple, rule-based configuration aspects.

In many cases, RuleType == AttributeType, but in some possibly not.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RuleBasedConfigAspect(Model model, com.google.inject.Key<AttributeType> key, java.lang.String aspectName, com.google.protobuf.Descriptors.Descriptor ruleDescriptor, java.util.List<RuleType> rules)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addToRuleBuilder(com.google.api.Service.Builder builder, java.lang.String selector, AttributeType attribute) Adds a rule back to the rule builder, specialized for the given selector.
protected abstract void	clearRuleBuilder(com.google.api.Service.Builder builder) Clears the rule builder during normalization.
void	endMerging() Default implementation ending merging; does nothing.
protected abstract AttributeType	evaluate(ProtoElement element, RuleType rule, boolean isFromIdl) Evaluates the rule w.r.t.
protected RuleType	fromIdlLayer(ProtoElement element) Attempts to synthesize the rule from the IDL, e.g.
protected abstract boolean	isApplicable(ProtoElement element) Predicate determining whether a rule of the aspect is applicable to the element.
void	merge(ProtoElement element) 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.
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.ConfigAspectBase

asDiagCollector, endLinting, endNormalization, error, getAspectName, getDocumentation, getDocumentationTitle, getLintRuleNames, getLocationInConfig, getLocationOfRepeatedFieldInConfig, getModel, lint, lintWarning, registerLintRule, registerLintRuleName, startLinting, startMerging, 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

RuleBasedConfigAspect

protected RuleBasedConfigAspect(Model model,
                                com.google.inject.Key<AttributeType> key,
                                java.lang.String aspectName,
                                com.google.protobuf.Descriptors.Descriptor ruleDescriptor,
                                java.util.List<RuleType> rules)

Method Detail

isApplicable

protected abstract boolean isApplicable(ProtoElement element)

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

fromIdlLayer

@Nullable
protected RuleType fromIdlLayer(ProtoElement element)

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.

evaluate

@Nullable
protected abstract AttributeType evaluate(ProtoElement element,
                                                    RuleType rule,
                                                    boolean isFromIdl)

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.

clearRuleBuilder

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

Clears the rule builder during normalization.

addToRuleBuilder

protected abstract void addToRuleBuilder(com.google.api.Service.Builder builder,
                                         java.lang.String selector,
                                         AttributeType attribute)

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

merge

public void merge(ProtoElement element)

Description copied from class: ConfigAspectBase

Default implementation for merging an element; does nothing.

Specified by:

merge in interface ConfigAspect

Overrides:

merge in class ConfigAspectBase

endMerging

public void endMerging()

Description copied from class: ConfigAspectBase

Default implementation ending merging; does nothing.

Specified by:

endMerging in interface ConfigAspect

Overrides:

endMerging in class ConfigAspectBase

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 ConfigAspectBase

normalize

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

Description copied from class: ConfigAspectBase

Default implementation to normalize an element; does nothing.

Specified by:

normalize in interface ConfigAspect

Overrides:

normalize in class ConfigAspectBase