com.google.api.tools.framework.aspects

Class ConfigRuleSet<RuleType extends com.google.protobuf.Message>

java.lang.Object

com.google.api.tools.framework.aspects.ConfigRuleSet<RuleType>

public class ConfigRuleSet<RuleType extends com.google.protobuf.Message>
extends java.lang.Object

Represents a configuration rule set, allowing to discover a configuration rule for a given proto element. Helper type to implement config aspects.

Constructor Summary

Constructors

Constructor and Description
ConfigRuleSet(com.google.protobuf.Descriptors.Descriptor ruleDescriptor, java.util.List<RuleType> rules, Model model)

Method Summary

Modifier and Type	Method and Description
RuleType	matchingRule(ProtoElement elem) Returns the matching rule for the element, or null, if no matching exists.
static <RuleType extends com.google.protobuf.Message> ConfigRuleSet<RuleType>	of(com.google.protobuf.Descriptors.Descriptor ruleDescriptor, java.util.List<RuleType> rules, Model model) Constructs a rule set for the given type and rules.
void	reportBadSelectors(DiagCollector collector, ConfigLocationResolver configLocationResolver, java.lang.String category) Validate selector syntax and report errors.
void	reportBadSelectors(DiagCollector collector, ConfigLocationResolver configLocationResolver, java.lang.String category, java.lang.String messagePrefix) Validate selector syntax and report errors (with given error message prefix).
void	reportUnmatchedRules(DiagCollector collector, ConfigLocationResolver configLocationResolver, java.lang.String category) Reports any unmatched rules.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigRuleSet

public ConfigRuleSet(com.google.protobuf.Descriptors.Descriptor ruleDescriptor,
                     java.util.List<RuleType> rules,
                     Model model)

Method Detail

of

public static <RuleType extends com.google.protobuf.Message> ConfigRuleSet<RuleType> of(com.google.protobuf.Descriptors.Descriptor ruleDescriptor,
                                                                                        java.util.List<RuleType> rules,
                                                                                        Model model)

Constructs a rule set for the given type and rules.

reportBadSelectors

public void reportBadSelectors(DiagCollector collector,
                               ConfigLocationResolver configLocationResolver,
                               java.lang.String category)

Validate selector syntax and report errors.

reportBadSelectors

public void reportBadSelectors(DiagCollector collector,
                               ConfigLocationResolver configLocationResolver,
                               java.lang.String category,
                               java.lang.String messagePrefix)

Validate selector syntax and report errors (with given error message prefix).

matchingRule

@Nullable
public RuleType matchingRule(ProtoElement elem)

Returns the matching rule for the element, or null, if no matching exists.

reportUnmatchedRules

public void reportUnmatchedRules(DiagCollector collector,
                                 ConfigLocationResolver configLocationResolver,
                                 java.lang.String category)

Reports any unmatched rules.