com.google.javascript.jscomp

Enum Requirement.Type

java.lang.Object

java.lang.Enum<Requirement.Type>

com.google.javascript.jscomp.Requirement.Type

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Requirement.Type>

Enclosing class:

Requirement

public static enum Requirement.Type
extends Enum<Requirement.Type>
implements com.google.protobuf.ProtocolMessageEnum

Protobuf enum jscomp.Requirement.Type

 A classification of the requirement and how it is enforced.
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
BANNED_CODE_PATTERN BANNED_CODE_PATTERN = 9;
BANNED_DEPENDENCY BANNED_DEPENDENCY = 2;
BANNED_NAME BANNED_NAME = 3;
BANNED_PROPERTY BANNED_PROPERTY = 4;
BANNED_PROPERTY_CALL BANNED_PROPERTY_CALL = 10;
BANNED_PROPERTY_READ BANNED_PROPERTY_READ = 5;
BANNED_PROPERTY_WRITE BANNED_PROPERTY_WRITE = 6;
CUSTOM CUSTOM = 1;
RESTRICTED_METHOD_CALL RESTRICTED_METHOD_CALL = 8;
RESTRICTED_NAME_CALL RESTRICTED_NAME_CALL = 7;

Field Summary

Fields

Modifier and Type	Field and Description
static int	BANNED_CODE_PATTERN_VALUE BANNED_CODE_PATTERN = 9;
static int	BANNED_DEPENDENCY_VALUE BANNED_DEPENDENCY = 2;
static int	BANNED_NAME_VALUE BANNED_NAME = 3;
static int	BANNED_PROPERTY_CALL_VALUE BANNED_PROPERTY_CALL = 10;
static int	BANNED_PROPERTY_READ_VALUE BANNED_PROPERTY_READ = 5;
static int	BANNED_PROPERTY_VALUE BANNED_PROPERTY = 4;
static int	BANNED_PROPERTY_WRITE_VALUE BANNED_PROPERTY_WRITE = 6;
static int	CUSTOM_VALUE CUSTOM = 1;
static int	RESTRICTED_METHOD_CALL_VALUE RESTRICTED_METHOD_CALL = 8;
static int	RESTRICTED_NAME_CALL_VALUE RESTRICTED_NAME_CALL = 7;

Method Summary

Methods

Modifier and Type	Method and Description
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<Requirement.Type>	internalGetValueMap()
static Requirement.Type	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static Requirement.Type	valueOf(int value)
static Requirement.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static Requirement.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CUSTOM

public static final Requirement.Type CUSTOM

CUSTOM = 1;

 A requirement enforced with code a external java class.
 

BANNED_DEPENDENCY

public static final Requirement.Type BANNED_DEPENDENCY

BANNED_DEPENDENCY = 2;

 A forbidden source file
 

BANNED_NAME

public static final Requirement.Type BANNED_NAME

BANNED_NAME = 3;

 A forbidden fully distinguished name. For example:
  - A global name like "eval" or "goog"
  - A namespaced value or type:  namespace.Banned
  - A 'static' property:  "namespace.Foo.banned"
 

BANNED_PROPERTY

public static final Requirement.Type BANNED_PROPERTY

BANNED_PROPERTY = 4;

 A banned instance property, for example:
  - An 'instance' property:   "namespace.Foo.prototype.banned"
  - All properties of a given name "Object.prototype.banned"
 

BANNED_PROPERTY_READ

public static final Requirement.Type BANNED_PROPERTY_READ

BANNED_PROPERTY_READ = 5;

 A banned reading from an instance property, for example:
  - An 'instance' property:   "namespace.Foo.prototype.banned"
  - All properties of a given name "Object.prototype.banned"
 Unlike BANNED_PROPERTY, this only bans reads to the property,
 i.e. its use as an rvalue.
 

BANNED_PROPERTY_WRITE

public static final Requirement.Type BANNED_PROPERTY_WRITE

BANNED_PROPERTY_WRITE = 6;

 A banned write to an instance property, for example:
  - An 'instance' property:   "namespace.Foo.prototype.banned"
  - All properties of a given name "Object.prototype.banned"
 Unlike BANNED_PROPERTY, this only bans assignments to the property,
 i.e. its use as an lvalue.
 

RESTRICTED_NAME_CALL

public static final Requirement.Type RESTRICTED_NAME_CALL

RESTRICTED_NAME_CALL = 7;

 A restricted call, for example:
  - the "parseInt" call must be called with a radix:
  parseInt:function(string, int)
 

RESTRICTED_METHOD_CALL

public static final Requirement.Type RESTRICTED_METHOD_CALL

RESTRICTED_METHOD_CALL = 8;

 A restricted call, for example:
  - The unsafe opt_html parameter must not be passed to createNode:
  goog.ui.tree.TreeControl.prototype.createNode:function()
 

BANNED_CODE_PATTERN

public static final Requirement.Type BANNED_CODE_PATTERN

BANNED_CODE_PATTERN = 9;

 A banned code pattern. This check is done using against an AST.
 To ban a call to eval:
    "/** @param {?} a */ function template(a) {eval(a);}"
 

BANNED_PROPERTY_CALL

public static final Requirement.Type BANNED_PROPERTY_CALL

BANNED_PROPERTY_CALL = 10;

 A banned function call. for example:
  - An 'instance' property: "namespace.Foo.prototype.banned"
  - All properties of a given name "Object.prototype.banned"
 Unlike BANNED_PROPERTY, this only bans calls to the property
 i.e. using the property as a value is allowed.
 

Field Detail

CUSTOM_VALUE

public static final int CUSTOM_VALUE

CUSTOM = 1;

 A requirement enforced with code a external java class.
 

See Also:

Constant Field Values

BANNED_DEPENDENCY_VALUE

public static final int BANNED_DEPENDENCY_VALUE

BANNED_DEPENDENCY = 2;

 A forbidden source file
 

See Also:

Constant Field Values

BANNED_NAME_VALUE

public static final int BANNED_NAME_VALUE

BANNED_NAME = 3;

 A forbidden fully distinguished name. For example:
  - A global name like "eval" or "goog"
  - A namespaced value or type:  namespace.Banned
  - A 'static' property:  "namespace.Foo.banned"
 

See Also:

Constant Field Values

BANNED_PROPERTY_VALUE

public static final int BANNED_PROPERTY_VALUE

BANNED_PROPERTY = 4;

 A banned instance property, for example:
  - An 'instance' property:   "namespace.Foo.prototype.banned"
  - All properties of a given name "Object.prototype.banned"
 

See Also:

Constant Field Values

BANNED_PROPERTY_READ_VALUE

public static final int BANNED_PROPERTY_READ_VALUE

BANNED_PROPERTY_READ = 5;

 A banned reading from an instance property, for example:
  - An 'instance' property:   "namespace.Foo.prototype.banned"
  - All properties of a given name "Object.prototype.banned"
 Unlike BANNED_PROPERTY, this only bans reads to the property,
 i.e. its use as an rvalue.
 

See Also:

Constant Field Values

BANNED_PROPERTY_WRITE_VALUE

public static final int BANNED_PROPERTY_WRITE_VALUE

BANNED_PROPERTY_WRITE = 6;

 A banned write to an instance property, for example:
  - An 'instance' property:   "namespace.Foo.prototype.banned"
  - All properties of a given name "Object.prototype.banned"
 Unlike BANNED_PROPERTY, this only bans assignments to the property,
 i.e. its use as an lvalue.
 

See Also:

Constant Field Values

RESTRICTED_NAME_CALL_VALUE

public static final int RESTRICTED_NAME_CALL_VALUE

RESTRICTED_NAME_CALL = 7;

 A restricted call, for example:
  - the "parseInt" call must be called with a radix:
  parseInt:function(string, int)
 

See Also:

Constant Field Values

RESTRICTED_METHOD_CALL_VALUE

public static final int RESTRICTED_METHOD_CALL_VALUE

RESTRICTED_METHOD_CALL = 8;

 A restricted call, for example:
  - The unsafe opt_html parameter must not be passed to createNode:
  goog.ui.tree.TreeControl.prototype.createNode:function()
 

See Also:

Constant Field Values

BANNED_CODE_PATTERN_VALUE

public static final int BANNED_CODE_PATTERN_VALUE

BANNED_CODE_PATTERN = 9;

 A banned code pattern. This check is done using against an AST.
 To ban a call to eval:
    "/** @param {?} a */ function template(a) {eval(a);}"
 

See Also:

Constant Field Values

BANNED_PROPERTY_CALL_VALUE

public static final int BANNED_PROPERTY_CALL_VALUE

BANNED_PROPERTY_CALL = 10;

 A banned function call. for example:
  - An 'instance' property: "namespace.Foo.prototype.banned"
  - All properties of a given name "Object.prototype.banned"
 Unlike BANNED_PROPERTY, this only bans calls to the property
 i.e. using the property as a value is allowed.
 

See Also:

Constant Field Values

Method Detail

values

public static Requirement.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Requirement.Type c : Requirement.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Requirement.Type valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

public static Requirement.Type valueOf(int value)

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<Requirement.Type> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static Requirement.Type valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)