com.google.javascript.jscomp

Interface RequirementOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Requirement, Requirement.Builder

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

Method Summary

Modifier and Type	Method and Description
String	getErrorMessage() optional string error_message = 1;
com.google.protobuf.ByteString	getErrorMessageBytes() optional string error_message = 1;
String	getExtends() optional string extends = 10;
com.google.protobuf.ByteString	getExtendsBytes() optional string extends = 10;
String	getJavaClass() optional string java_class = 8;
com.google.protobuf.ByteString	getJavaClassBytes() optional string java_class = 8;
String	getOnlyApplyTo(int index) repeated string only_apply_to = 4;
com.google.protobuf.ByteString	getOnlyApplyToBytes(int index) repeated string only_apply_to = 4;
int	getOnlyApplyToCount() repeated string only_apply_to = 4;
List<String>	getOnlyApplyToList() repeated string only_apply_to = 4;
String	getOnlyApplyToRegexp(int index) repeated string only_apply_to_regexp = 5;
com.google.protobuf.ByteString	getOnlyApplyToRegexpBytes(int index) repeated string only_apply_to_regexp = 5;
int	getOnlyApplyToRegexpCount() repeated string only_apply_to_regexp = 5;
List<String>	getOnlyApplyToRegexpList() repeated string only_apply_to_regexp = 5;
boolean	getReportLooseTypeViolations() optional bool report_loose_type_violations = 11 [default = true];
String	getRuleId() optional string rule_id = 9;
com.google.protobuf.ByteString	getRuleIdBytes() optional string rule_id = 9;
Requirement.Type	getType() optional .jscomp.Requirement.Type type = 6;
String	getValue(int index) repeated string value = 7;
com.google.protobuf.ByteString	getValueBytes(int index) repeated string value = 7;
int	getValueCount() repeated string value = 7;
List<String>	getValueList() repeated string value = 7;
String	getWhitelist(int index) repeated string whitelist = 2;
com.google.protobuf.ByteString	getWhitelistBytes(int index) repeated string whitelist = 2;
int	getWhitelistCount() repeated string whitelist = 2;
List<String>	getWhitelistList() repeated string whitelist = 2;
String	getWhitelistRegexp(int index) repeated string whitelist_regexp = 3;
com.google.protobuf.ByteString	getWhitelistRegexpBytes(int index) repeated string whitelist_regexp = 3;
int	getWhitelistRegexpCount() repeated string whitelist_regexp = 3;
List<String>	getWhitelistRegexpList() repeated string whitelist_regexp = 3;
boolean	hasErrorMessage() optional string error_message = 1;
boolean	hasExtends() optional string extends = 10;
boolean	hasJavaClass() optional string java_class = 8;
boolean	hasReportLooseTypeViolations() optional bool report_loose_type_violations = 11 [default = true];
boolean	hasRuleId() optional string rule_id = 9;
boolean	hasType() optional .jscomp.Requirement.Type type = 6;

Methods inherited from interface com.google.protobuf.GeneratedMessage.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()

optional string error_message = 1;

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

getErrorMessage

String getErrorMessage()

optional string error_message = 1;

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

getErrorMessageBytes

com.google.protobuf.ByteString getErrorMessageBytes()

optional string error_message = 1;

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

getWhitelistList

List<String> getWhitelistList()

repeated string whitelist = 2;

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

getWhitelistCount

int getWhitelistCount()

repeated string whitelist = 2;

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

getWhitelist

String getWhitelist(int index)

repeated string whitelist = 2;

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

getWhitelistBytes

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

repeated string whitelist = 2;

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

getWhitelistRegexpList

List<String> getWhitelistRegexpList()

repeated string whitelist_regexp = 3;

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

getWhitelistRegexpCount

int getWhitelistRegexpCount()

repeated string whitelist_regexp = 3;

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

getWhitelistRegexp

String getWhitelistRegexp(int index)

repeated string whitelist_regexp = 3;

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

getWhitelistRegexpBytes

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

repeated string whitelist_regexp = 3;

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

getOnlyApplyToList

List<String> getOnlyApplyToList()

repeated string only_apply_to = 4;

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

getOnlyApplyToCount

int getOnlyApplyToCount()

repeated string only_apply_to = 4;

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

getOnlyApplyTo

String getOnlyApplyTo(int index)

repeated string only_apply_to = 4;

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

getOnlyApplyToBytes

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

repeated string only_apply_to = 4;

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

getOnlyApplyToRegexpList

List<String> getOnlyApplyToRegexpList()

repeated string only_apply_to_regexp = 5;

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

getOnlyApplyToRegexpCount

int getOnlyApplyToRegexpCount()

repeated string only_apply_to_regexp = 5;

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

getOnlyApplyToRegexp

String getOnlyApplyToRegexp(int index)

repeated string only_apply_to_regexp = 5;

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

getOnlyApplyToRegexpBytes

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

repeated string only_apply_to_regexp = 5;

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

hasType

boolean hasType()

optional .jscomp.Requirement.Type type = 6;

 Required: The type of requirement.
 

getType

Requirement.Type getType()

optional .jscomp.Requirement.Type type = 6;

 Required: The type of requirement.
 

getValueList

List<String> getValueList()

repeated string value = 7;

 The value banned, optional for "custom" requirements.
 

getValueCount

int getValueCount()

repeated string value = 7;

 The value banned, optional for "custom" requirements.
 

getValue

String getValue(int index)

repeated string value = 7;

 The value banned, optional for "custom" requirements.
 

getValueBytes

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

repeated string value = 7;

 The value banned, optional for "custom" requirements.
 

hasJavaClass

boolean hasJavaClass()

optional string java_class = 8;

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

getJavaClass

String getJavaClass()

optional string java_class = 8;

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

getJavaClassBytes

com.google.protobuf.ByteString getJavaClassBytes()

optional string java_class = 8;

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

hasRuleId

boolean hasRuleId()

optional string rule_id = 9;

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

getRuleId

String getRuleId()

optional string rule_id = 9;

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

getRuleIdBytes

com.google.protobuf.ByteString getRuleIdBytes()

optional string rule_id = 9;

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

hasExtends

boolean hasExtends()

optional string extends = 10;

 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.
 

getExtends

String getExtends()

optional string extends = 10;

 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.
 

getExtendsBytes

com.google.protobuf.ByteString getExtendsBytes()

optional string extends = 10;

 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.
 

hasReportLooseTypeViolations

boolean hasReportLooseTypeViolations()

optional bool report_loose_type_violations = 11 [default = true];

 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).
 

getReportLooseTypeViolations

boolean getReportLooseTypeViolations()

optional bool report_loose_type_violations = 11 [default = true];

 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).