com.google.api.tools.framework.aspects.http

Class HttpConfigAspect

java.lang.Object

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

com.google.api.tools.framework.aspects.RuleBasedConfigAspect<com.google.api.HttpRule,HttpAttribute>

com.google.api.tools.framework.aspects.http.HttpConfigAspect

All Implemented Interfaces:

ConfigAspect

public class HttpConfigAspect
extends RuleBasedConfigAspect<com.google.api.HttpRule,HttpAttribute>

Configuration aspect for the http binding.

The attribute used for representing the binding is HttpAttribute.

Method Summary

Modifier and Type	Method and Description
protected void	addToRuleBuilder(com.google.api.Service.Builder builder, java.lang.String selector, HttpAttribute 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 HttpConfigAspect	create(Model model) Creates http config aspect.
void	endMerging() Default implementation ending merging; does nothing.
protected HttpAttribute	evaluate(ProtoElement element, com.google.api.HttpRule rule, boolean isFromIdl) Evaluates the rule w.r.t.
protected com.google.api.HttpRule	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() Depends on documentation aspect via consumption of ResourceAttribute.
void	startMerging() Default implementation of starting merge; does nothing.

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

merge, normalize, startNormalization

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 HttpConfigAspect create(Model model)

Creates http config aspect.

mergeDependencies

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

Depends on documentation aspect via consumption of ResourceAttribute.

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

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.HttpRule,HttpAttribute>

fromIdlLayer

protected com.google.api.HttpRule 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.HttpRule,HttpAttribute>

evaluate

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

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 RuleBasedConfigAspect<com.google.api.HttpRule,HttpAttribute>

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.HttpRule,HttpAttribute>

addToRuleBuilder

protected void addToRuleBuilder(com.google.api.Service.Builder builder,
                                java.lang.String selector,
                                HttpAttribute 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.HttpRule,HttpAttribute>