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-linter Show documentation
Show all versions of closure-compiler-linter 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.
This binary checks for style issues such as incorrect or missing JSDoc
usage, and missing goog.require() statements. It does not do more advanced
checks such as typechecking.
// 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;
*/
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;
*/
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;
*/
com.google.protobuf.ByteString
getErrorMessageBytes();
/**
*
* Optional: A list of source path prefixes that are exempt from the
* requirement.
*
*
* repeated string whitelist = 2;
*/
java.util.List
getWhitelistList();
/**
*
* Optional: A list of source path prefixes that are exempt from the
* requirement.
*
*
* repeated string whitelist = 2;
*/
int getWhitelistCount();
/**
*
* Optional: A list of source path prefixes that are exempt from the
* requirement.
*
*
* repeated string whitelist = 2;
*/
java.lang.String getWhitelist(int index);
/**
*
* Optional: A list of source path prefixes that are exempt from the
* requirement.
*
*
* repeated string whitelist = 2;
*/
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;
*/
java.util.List
getWhitelistRegexpList();
/**
*
* Optional: A list of source paths regexs that are exempt from the
* requirement.
*
*
* repeated string whitelist_regexp = 3;
*/
int getWhitelistRegexpCount();
/**
*
* Optional: A list of source paths regexs that are exempt from the
* requirement.
*
*
* repeated string whitelist_regexp = 3;
*/
java.lang.String getWhitelistRegexp(int index);
/**
*
* Optional: A list of source paths regexs that are exempt from the
* requirement.
*
*
* repeated string whitelist_regexp = 3;
*/
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 extends com.google.javascript.jscomp.Requirement.WhitelistEntryOrBuilder>
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;
*/
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;
*/
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;
*/
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;
*/
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;
*/
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;
*/
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;
*/
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;
*/
com.google.protobuf.ByteString
getOnlyApplyToRegexpBytes(int index);
/**
*
* Required: The type of requirement.
*
*
* optional .jscomp.Requirement.Type type = 6;
*/
boolean hasType();
/**
*
* Required: The type of requirement.
*
*
* optional .jscomp.Requirement.Type type = 6;
*/
com.google.javascript.jscomp.Requirement.Type getType();
/**
*
* The value banned, optional for "custom" requirements.
*
*
* repeated string value = 7;
*/
java.util.List
getValueList();
/**
*
* The value banned, optional for "custom" requirements.
*
*
* repeated string value = 7;
*/
int getValueCount();
/**
*
* The value banned, optional for "custom" requirements.
*
*
* repeated string value = 7;
*/
java.lang.String getValue(int index);
/**
*
* The value banned, optional for "custom" requirements.
*
*
* repeated string value = 7;
*/
com.google.protobuf.ByteString
getValueBytes(int index);
/**
*
* 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];
*/
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];
*/
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;
*/
boolean hasJavaClass();
/**
*
* For "custom" requirements, the Java class used to enforce the requirement.
* Ignored otherwise.
*
*
* optional string java_class = 8;
*/
java.lang.String getJavaClass();
/**
*
* For "custom" requirements, the Java class used to enforce the requirement.
* Ignored otherwise.
*
*
* optional string java_class = 8;
*/
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;
*/
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;
*/
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;
*/
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;
*/
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;
*/
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;
*/
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];
*/
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];
*/
boolean getReportLooseTypeViolations();
/**
* optional .jscomp.Requirement.Severity severity = 12 [default = WARNING];
*/
boolean hasSeverity();
/**
* optional .jscomp.Requirement.Severity severity = 12 [default = WARNING];
*/
com.google.javascript.jscomp.Requirement.Severity getSeverity();
}