com.google.api.tools.framework.aspects.usage

Class UsageConfigAspect

java.lang.Object

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

com.google.api.tools.framework.aspects.RuleBasedConfigAspect<com.google.api.UsageRule,com.google.api.UsageRule>

com.google.api.tools.framework.aspects.usage.UsageConfigAspect

All Implemented Interfaces:

ConfigAspect

public class UsageConfigAspect
extends RuleBasedConfigAspect<com.google.api.UsageRule,com.google.api.UsageRule>

Configuration aspect for usage section.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BILLING_REQUIREMENT
static java.lang.String	TOS_REQUIREMENT_PREFIX
static java.lang.String	UTOS_REQUIREMENT

Method Summary

Modifier and Type	Method and Description
protected void	addToRuleBuilder(com.google.api.Service.Builder builder, java.lang.String selector, com.google.api.UsageRule binding) 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 ConfigAspectBase	create(Model model) Creates usage config aspect.
protected com.google.api.UsageRule	evaluate(ProtoElement element, com.google.api.UsageRule rule, boolean isFromIdl) Evaluates the rule w.r.t.
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, fromIdlLayer, 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

Field Detail

BILLING_REQUIREMENT

public static final java.lang.String BILLING_REQUIREMENT

See Also:

Constant Field Values

TOS_REQUIREMENT_PREFIX

public static final java.lang.String TOS_REQUIREMENT_PREFIX

See Also:

Constant Field Values

UTOS_REQUIREMENT

public static final java.lang.String UTOS_REQUIREMENT

See Also:

Constant Field Values

Method Detail

create

public static ConfigAspectBase create(Model model)

Creates usage config aspect.

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.

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

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.UsageRule,com.google.api.UsageRule>

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.UsageRule,com.google.api.UsageRule>

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.UsageRule,com.google.api.UsageRule>

addToRuleBuilder

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

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.UsageRule,com.google.api.UsageRule>

evaluate

protected com.google.api.UsageRule evaluate(ProtoElement element,
                                            com.google.api.UsageRule 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.UsageRule,com.google.api.UsageRule>