com.google.javascript.jscomp

Interface RequirementOrBuilder

All Superinterfaces:

com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<Requirement>, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Requirement, Requirement.Builder

public interface RequirementOrBuilder
extends com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<Requirement>

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorMessage() Required: The message to report when a requirement is violated.
com.google.protobuf.ByteString	getErrorMessageBytes() Required: The message to report when a requirement is violated.
java.lang.String	getExtends() Allows extending whitelists of rules with the specified rule_id.
com.google.protobuf.ByteString	getExtendsBytes() Allows extending whitelists of rules with the specified rule_id.
java.lang.String	getJavaClass() For "custom" requirements, the Java class used to enforce the requirement.
com.google.protobuf.ByteString	getJavaClassBytes() For "custom" requirements, the Java class used to enforce the requirement.
java.lang.String	getOnlyApplyTo(int index) Optional: A list of source paths that will be checked for the requirement (the opposite of whitelist).
com.google.protobuf.ByteString	getOnlyApplyToBytes(int index) Optional: A list of source paths that will be checked for the requirement (the opposite of whitelist).
int	getOnlyApplyToCount() Optional: A list of source paths that will be checked for the requirement (the opposite of whitelist).
java.util.List<java.lang.String>	getOnlyApplyToList() Optional: A list of source paths that will be checked for the requirement (the opposite of whitelist).
java.lang.String	getOnlyApplyToRegexp(int index) Optional: A list of source path regexps that will be checked for the requirement (the opposite of whitelist_regexp).
com.google.protobuf.ByteString	getOnlyApplyToRegexpBytes(int index) Optional: A list of source path regexps that will be checked for the requirement (the opposite of whitelist_regexp).
int	getOnlyApplyToRegexpCount() Optional: A list of source path regexps that will be checked for the requirement (the opposite of whitelist_regexp).
java.util.List<java.lang.String>	getOnlyApplyToRegexpList() Optional: A list of source path regexps that will be checked for the requirement (the opposite of whitelist_regexp).
boolean	getReportLooseTypeViolations() Whether to report possible violations when type information is not exact.
java.lang.String	getRuleId() Gives the rule an unique ID that can be used for extending in other rules through 'extends'.
com.google.protobuf.ByteString	getRuleIdBytes() Gives the rule an unique ID that can be used for extending in other rules through 'extends'.
Requirement.Type	getType() Required: The type of requirement.
java.lang.String	getValue(int index) The value banned, optional for "custom" requirements.
com.google.protobuf.ByteString	getValueBytes(int index) The value banned, optional for "custom" requirements.
int	getValueCount() The value banned, optional for "custom" requirements.
java.util.List<java.lang.String>	getValueList() The value banned, optional for "custom" requirements.
java.lang.String	getWhitelist(int index) Optional: A list of source path prefixes that are exempt from the requirement.
com.google.protobuf.ByteString	getWhitelistBytes(int index) Optional: A list of source path prefixes that are exempt from the requirement.
int	getWhitelistCount() Optional: A list of source path prefixes that are exempt from the requirement.
java.util.List<java.lang.String>	getWhitelistList() Optional: A list of source path prefixes that are exempt from the requirement.
java.lang.String	getWhitelistRegexp(int index) Optional: A list of source paths regexs that are exempt from the requirement.
com.google.protobuf.ByteString	getWhitelistRegexpBytes(int index) Optional: A list of source paths regexs that are exempt from the requirement.
int	getWhitelistRegexpCount() Optional: A list of source paths regexs that are exempt from the requirement.
java.util.List<java.lang.String>	getWhitelistRegexpList() Optional: A list of source paths regexs that are exempt from the requirement.
boolean	hasErrorMessage() Required: The message to report when a requirement is violated.
boolean	hasExtends() Allows extending whitelists of rules with the specified rule_id.
boolean	hasJavaClass() For "custom" requirements, the Java class used to enforce the requirement.
boolean	hasReportLooseTypeViolations() Whether to report possible violations when type information is not exact.
boolean	hasRuleId() Gives the rule an unique ID that can be used for extending in other rules through 'extends'.
boolean	hasType() Required: The type of requirement.

Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder

getDefaultInstanceForType, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasErrorMessage

boolean hasErrorMessage()

 Required: The message to report when a requirement is violated. This should
 reference a document describing the reasoning for the requirement
 and contacts.
 

optional string error_message = 1;

getErrorMessage

java.lang.String getErrorMessage()

 Required: The message to report when a requirement is violated. This should
 reference a document describing the reasoning for the requirement
 and contacts.
 

optional string error_message = 1;

getErrorMessageBytes

com.google.protobuf.ByteString getErrorMessageBytes()

 Required: The message to report when a requirement is violated. This should
 reference a document describing the reasoning for the requirement
 and contacts.
 

optional string error_message = 1;

getWhitelistList

java.util.List<java.lang.String> getWhitelistList()

 Optional: A list of source path prefixes that are exempt from the
 requirement.
 

repeated string whitelist = 2;

getWhitelistCount

int getWhitelistCount()

 Optional: A list of source path prefixes that are exempt from the
 requirement.
 

repeated string whitelist = 2;

getWhitelist

java.lang.String getWhitelist(int index)

 Optional: A list of source path prefixes that are exempt from the
 requirement.
 

repeated string whitelist = 2;

getWhitelistBytes

com.google.protobuf.ByteString getWhitelistBytes(int index)

 Optional: A list of source path prefixes that are exempt from the
 requirement.
 

repeated string whitelist = 2;

getWhitelistRegexpList

java.util.List<java.lang.String> getWhitelistRegexpList()

 Optional: A list of source paths regexs that are exempt from the
 requirement.
 

repeated string whitelist_regexp = 3;

getWhitelistRegexpCount

int getWhitelistRegexpCount()

 Optional: A list of source paths regexs that are exempt from the
 requirement.
 

repeated string whitelist_regexp = 3;

getWhitelistRegexp

java.lang.String getWhitelistRegexp(int index)

 Optional: A list of source paths regexs that are exempt from the
 requirement.
 

repeated string whitelist_regexp = 3;

getWhitelistRegexpBytes

com.google.protobuf.ByteString getWhitelistRegexpBytes(int index)

 Optional: A list of source paths regexs that are exempt from the
 requirement.
 

repeated string whitelist_regexp = 3;

getOnlyApplyToList

java.util.List<java.lang.String> getOnlyApplyToList()

 Optional: A list of source paths that will be checked for the requirement
 (the opposite of whitelist).
 

repeated string only_apply_to = 4;

getOnlyApplyToCount

int getOnlyApplyToCount()

 Optional: A list of source paths that will be checked for the requirement
 (the opposite of whitelist).
 

repeated string only_apply_to = 4;

getOnlyApplyTo

java.lang.String getOnlyApplyTo(int index)

 Optional: A list of source paths that will be checked for the requirement
 (the opposite of whitelist).
 

repeated string only_apply_to = 4;

getOnlyApplyToBytes

com.google.protobuf.ByteString getOnlyApplyToBytes(int index)

 Optional: A list of source paths that will be checked for the requirement
 (the opposite of whitelist).
 

repeated string only_apply_to = 4;

getOnlyApplyToRegexpList

java.util.List<java.lang.String> getOnlyApplyToRegexpList()

 Optional: A list of source path regexps that will be checked for
 the requirement (the opposite of whitelist_regexp).
 

repeated string only_apply_to_regexp = 5;

getOnlyApplyToRegexpCount

int getOnlyApplyToRegexpCount()

 Optional: A list of source path regexps that will be checked for
 the requirement (the opposite of whitelist_regexp).
 

repeated string only_apply_to_regexp = 5;

getOnlyApplyToRegexp

java.lang.String getOnlyApplyToRegexp(int index)

 Optional: A list of source path regexps that will be checked for
 the requirement (the opposite of whitelist_regexp).
 

repeated string only_apply_to_regexp = 5;

getOnlyApplyToRegexpBytes

com.google.protobuf.ByteString getOnlyApplyToRegexpBytes(int index)

 Optional: A list of source path regexps that will be checked for
 the requirement (the opposite of whitelist_regexp).
 

repeated string only_apply_to_regexp = 5;

hasType

boolean hasType()

 Required: The type of requirement.
 

optional .jscomp.Requirement.Type type = 6;

getType

Requirement.Type getType()

 Required: The type of requirement.
 

optional .jscomp.Requirement.Type type = 6;

getValueList

java.util.List<java.lang.String> getValueList()

 The value banned, optional for "custom" requirements.
 

repeated string value = 7;

getValueCount

int getValueCount()

 The value banned, optional for "custom" requirements.
 

repeated string value = 7;

getValue

java.lang.String getValue(int index)

 The value banned, optional for "custom" requirements.
 

repeated string value = 7;

getValueBytes

com.google.protobuf.ByteString getValueBytes(int index)

 The value banned, optional for "custom" requirements.
 

repeated string value = 7;

hasJavaClass

boolean hasJavaClass()

 For "custom" requirements, the Java class used to enforce the requirement.
 Ignored otherwise.
 

optional string java_class = 8;

getJavaClass

java.lang.String getJavaClass()

 For "custom" requirements, the Java class used to enforce the requirement.
 Ignored otherwise.
 

optional string java_class = 8;

getJavaClassBytes

com.google.protobuf.ByteString getJavaClassBytes()

 For "custom" requirements, the Java class used to enforce the requirement.
 Ignored otherwise.
 

optional string java_class = 8;

hasRuleId

boolean hasRuleId()

 Gives the rule an unique ID that can be used for extending in other rules
 through 'extends'. An example of ID is 'closure:innerHtml'.
 

optional string rule_id = 9;

getRuleId

java.lang.String getRuleId()

 Gives the rule an unique ID that can be used for extending in other rules
 through 'extends'. An example of ID is 'closure:innerHtml'.
 

optional string rule_id = 9;

getRuleIdBytes

com.google.protobuf.ByteString getRuleIdBytes()

 Gives the rule an unique ID that can be used for extending in other rules
 through 'extends'. An example of ID is 'closure:innerHtml'.
 

optional string rule_id = 9;

hasExtends

boolean hasExtends()

 Allows extending whitelists of rules with the specified rule_id. If this
 field is specified then all fields except whitelist, whitelist_regexp,
 only_apply_to and only_apply_to_regexp are ignored.
 

optional string extends = 10;

getExtends

java.lang.String getExtends()

 Allows extending whitelists of rules with the specified rule_id. If this
 field is specified then all fields except whitelist, whitelist_regexp,
 only_apply_to and only_apply_to_regexp are ignored.
 

optional string extends = 10;

getExtendsBytes

com.google.protobuf.ByteString getExtendsBytes()

 Allows extending whitelists of rules with the specified rule_id. If this
 field is specified then all fields except whitelist, whitelist_regexp,
 only_apply_to and only_apply_to_regexp are ignored.
 

optional string extends = 10;

hasReportLooseTypeViolations

boolean hasReportLooseTypeViolations()

 Whether to report possible violations when type information is not exact.
 Normally, violations on parent types are reported as possible violations.
 This field allows to ignore them and report only violations on exact types.
 This changes the balance between the false positives and the false
 negatives. With the default value, there might be lots of false positives
 (possible violations) but there shouldn't be any false negatives. Without
 reporting the loose type violations, there will be less false positives but
 there can also be false negatives (an actual violation that is not
 reported).
 

optional bool report_loose_type_violations = 11 [default = true];

getReportLooseTypeViolations

boolean getReportLooseTypeViolations()

 Whether to report possible violations when type information is not exact.
 Normally, violations on parent types are reported as possible violations.
 This field allows to ignore them and report only violations on exact types.
 This changes the balance between the false positives and the false
 negatives. With the default value, there might be lots of false positives
 (possible violations) but there shouldn't be any false negatives. Without
 reporting the loose type violations, there will be less false positives but
 there can also be false negatives (an actual violation that is not
 reported).
 

optional bool report_loose_type_violations = 11 [default = true];