com.google.javascript.jscomp.RequirementOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of closure-compiler Show documentation
Show all versions of closure-compiler Show documentation
Closure Compiler is a JavaScript optimizing compiler. It parses your
JavaScript, analyzes it, removes dead code and rewrites and minimizes
what's left. It also checks syntax, variable references, and types, and
warns about common JavaScript pitfalls. It is used in many of Google's
JavaScript apps, including Gmail, Google Web Search, Google Maps, and
Google Docs.
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: conformance.proto
package com.google.javascript.jscomp;
public interface RequirementOrBuilder extends
// @@protoc_insertion_point(interface_extends:jscomp.Requirement)
com.google.protobuf.GeneratedMessageV3.
ExtendableMessageOrBuilder {
/**
*
* 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;
* @return Whether the errorMessage field is set.
*/
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;
* @return The errorMessage.
*/
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;
* @return The bytes for errorMessage.
*/
com.google.protobuf.ByteString
getErrorMessageBytes();
/**
*
* Optional: A list of source path prefixes that are exempt from the
* requirement.
*
*
* repeated string whitelist = 2;
* @return A list containing the whitelist.
*/
java.util.List
getWhitelistList();
/**
*
* Optional: A list of source path prefixes that are exempt from the
* requirement.
*
*
* repeated string whitelist = 2;
* @return The count of whitelist.
*/
int getWhitelistCount();
/**
*
* Optional: A list of source path prefixes that are exempt from the
* requirement.
*
*
* repeated string whitelist = 2;
* @param index The index of the element to return.
* @return The whitelist at the given index.
*/
java.lang.String getWhitelist(int index);
/**
*
* Optional: A list of source path prefixes that are exempt from the
* requirement.
*
*
* repeated string whitelist = 2;
* @param index The index of the value to return.
* @return The bytes of the whitelist at the given index.
*/
com.google.protobuf.ByteString
getWhitelistBytes(int index);
/**
*
* Optional: A list of source paths regexs that are exempt from the
* requirement.
*
*
* repeated string whitelist_regexp = 3;
* @return A list containing the whitelistRegexp.
*/
java.util.List
getWhitelistRegexpList();
/**
*
* Optional: A list of source paths regexs that are exempt from the
* requirement.
*
*
* repeated string whitelist_regexp = 3;
* @return The count of whitelistRegexp.
*/
int getWhitelistRegexpCount();
/**
*
* Optional: A list of source paths regexs that are exempt from the
* requirement.
*
*
* repeated string whitelist_regexp = 3;
* @param index The index of the element to return.
* @return The whitelistRegexp at the given index.
*/
java.lang.String getWhitelistRegexp(int index);
/**
*
* Optional: A list of source paths regexs that are exempt from the
* requirement.
*
*
* repeated string whitelist_regexp = 3;
* @param index The index of the value to return.
* @return The bytes of the whitelistRegexp at the given index.
*/
com.google.protobuf.ByteString
getWhitelistRegexpBytes(int index);
/**
* repeated .jscomp.Requirement.WhitelistEntry whitelist_entry = 14;
*/
java.util.List
getWhitelistEntryList();
/**
* repeated .jscomp.Requirement.WhitelistEntry whitelist_entry = 14;
*/
com.google.javascript.jscomp.Requirement.WhitelistEntry getWhitelistEntry(int index);
/**
* repeated .jscomp.Requirement.WhitelistEntry whitelist_entry = 14;
*/
int getWhitelistEntryCount();
/**
* repeated .jscomp.Requirement.WhitelistEntry whitelist_entry = 14;
*/
java.util.List
getWhitelistEntryOrBuilderList();
/**
* repeated .jscomp.Requirement.WhitelistEntry whitelist_entry = 14;
*/
com.google.javascript.jscomp.Requirement.WhitelistEntryOrBuilder getWhitelistEntryOrBuilder(
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;
* @return A list containing the onlyApplyTo.
*/
java.util.List
getOnlyApplyToList();
/**
*
* Optional: A list of source paths that will be checked for the requirement
* (the opposite of whitelist).
*
*
* repeated string only_apply_to = 4;
* @return The count of onlyApplyTo.
*/
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;
* @param index The index of the element to return.
* @return The onlyApplyTo at the given index.
*/
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;
* @param index The index of the value to return.
* @return The bytes of the onlyApplyTo at the given index.
*/
com.google.protobuf.ByteString
getOnlyApplyToBytes(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;
* @return A list containing the onlyApplyToRegexp.
*/
java.util.List
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;
* @return The count of onlyApplyToRegexp.
*/
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;
* @param index The index of the element to return.
* @return The onlyApplyToRegexp at the given index.
*/
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;
* @param index The index of the value to return.
* @return The bytes of the onlyApplyToRegexp at the given index.
*/
com.google.protobuf.ByteString
getOnlyApplyToRegexpBytes(int index);
/**
*
* Required: The type of requirement.
*
*
* optional .jscomp.Requirement.Type type = 6;
* @return Whether the type field is set.
*/
boolean hasType();
/**
*
* Required: The type of requirement.
*
*
* optional .jscomp.Requirement.Type type = 6;
* @return The type.
*/
com.google.javascript.jscomp.Requirement.Type getType();
/**
*
* The value banned, optional for "custom" requirements. Some custom
* requirements repurpose this for different purposes, such as for whitelists
* of types.
*
*
* repeated string value = 7;
* @return A list containing the value.
*/
java.util.List
getValueList();
/**
*
* The value banned, optional for "custom" requirements. Some custom
* requirements repurpose this for different purposes, such as for whitelists
* of types.
*
*
* repeated string value = 7;
* @return The count of value.
*/
int getValueCount();
/**
*
* The value banned, optional for "custom" requirements. Some custom
* requirements repurpose this for different purposes, such as for whitelists
* of types.
*
*
* repeated string value = 7;
* @param index The index of the element to return.
* @return The value at the given index.
*/
java.lang.String getValue(int index);
/**
*
* The value banned, optional for "custom" requirements. Some custom
* requirements repurpose this for different purposes, such as for whitelists
* of types.
*
*
* repeated string value = 7;
* @param index The index of the value to return.
* @return The bytes of the value at the given index.
*/
com.google.protobuf.ByteString
getValueBytes(int index);
/**
*
* Whether to allow subconfigs to extend the "value" field. This does not
* make sense for banning values, but when the value is used as a whitelist,
* it becomes important.
*
*
* optional bool allow_extending_value = 15;
* @return Whether the allowExtendingValue field is set.
*/
boolean hasAllowExtendingValue();
/**
*
* Whether to allow subconfigs to extend the "value" field. This does not
* make sense for banning values, but when the value is used as a whitelist,
* it becomes important.
*
*
* optional bool allow_extending_value = 15;
* @return The allowExtendingValue.
*/
boolean getAllowExtendingValue();
/**
*
* Strategy to use for matching types in the value parameter (e.g. for
* BANNED_CODE_PATTERN checks).
*
*
* optional .jscomp.Requirement.TypeMatchingStrategy type_matching_strategy = 13 [default = LOOSE];
* @return Whether the typeMatchingStrategy field is set.
*/
boolean hasTypeMatchingStrategy();
/**
*
* Strategy to use for matching types in the value parameter (e.g. for
* BANNED_CODE_PATTERN checks).
*
*
* optional .jscomp.Requirement.TypeMatchingStrategy type_matching_strategy = 13 [default = LOOSE];
* @return The typeMatchingStrategy.
*/
com.google.javascript.jscomp.Requirement.TypeMatchingStrategy getTypeMatchingStrategy();
/**
*
* For "custom" requirements, the Java class used to enforce the requirement.
* Ignored otherwise.
*
*
* optional string java_class = 8;
* @return Whether the javaClass field is set.
*/
boolean hasJavaClass();
/**
*
* For "custom" requirements, the Java class used to enforce the requirement.
* Ignored otherwise.
*
*
* optional string java_class = 8;
* @return The javaClass.
*/
java.lang.String getJavaClass();
/**
*
* For "custom" requirements, the Java class used to enforce the requirement.
* Ignored otherwise.
*
*
* optional string java_class = 8;
* @return The bytes for javaClass.
*/
com.google.protobuf.ByteString
getJavaClassBytes();
/**
*
* 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;
* @return Whether the ruleId field is set.
*/
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;
* @return The ruleId.
*/
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;
* @return The bytes for ruleId.
*/
com.google.protobuf.ByteString
getRuleIdBytes();
/**
*
* 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;
* @return Whether the extends field is set.
*/
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;
* @return The extends.
*/
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;
* @return The bytes for extends.
*/
com.google.protobuf.ByteString
getExtendsBytes();
/**
*
* 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];
* @return Whether the reportLooseTypeViolations field is set.
*/
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];
* @return The reportLooseTypeViolations.
*/
boolean getReportLooseTypeViolations();
/**
* optional .jscomp.Requirement.Severity severity = 12 [default = WARNING];
* @return Whether the severity field is set.
*/
boolean hasSeverity();
/**
* optional .jscomp.Requirement.Severity severity = 12 [default = WARNING];
* @return The severity.
*/
com.google.javascript.jscomp.Requirement.Severity getSeverity();
/**
*
* The file(s) that defined this requirement. If the requirement is extended,
* then all extending files are included as well. These will be printed in
* the error message.
*
*
* repeated string config_file = 16;
* @return A list containing the configFile.
*/
java.util.List
getConfigFileList();
/**
*
* The file(s) that defined this requirement. If the requirement is extended,
* then all extending files are included as well. These will be printed in
* the error message.
*
*
* repeated string config_file = 16;
* @return The count of configFile.
*/
int getConfigFileCount();
/**
*
* The file(s) that defined this requirement. If the requirement is extended,
* then all extending files are included as well. These will be printed in
* the error message.
*
*
* repeated string config_file = 16;
* @param index The index of the element to return.
* @return The configFile at the given index.
*/
java.lang.String getConfigFile(int index);
/**
*
* The file(s) that defined this requirement. If the requirement is extended,
* then all extending files are included as well. These will be printed in
* the error message.
*
*
* repeated string config_file = 16;
* @param index The index of the value to return.
* @return The bytes of the configFile at the given index.
*/
com.google.protobuf.ByteString
getConfigFileBytes(int index);
}