Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.google.javascript.rhino.jstype
Class EnumElementType

java.lang.Object
  extended by com.google.javascript.rhino.jstype.JSType
      extended by com.google.javascript.rhino.jstype.ObjectType
          extended by com.google.javascript.rhino.jstype.EnumElementType
All Implemented Interfaces:
StaticScope<JSType>, Serializable
public class EnumElementType
extends ObjectType

The type of individual elements of an enum type (see EnumType).

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.javascript.rhino.jstype.JSType
JSType.TypePair
 
Field Summary
 
Fields inherited from class com.google.javascript.rhino.jstype.JSType
EMPTY_TYPE_COMPONENT, ENUMDECL, NOT_A_CLASS, NOT_A_TYPE, NOT_ENUMDECL, templateTypeMap, UNKNOWN_NAME
 
Method Summary
 JSType autoboxesTo()
          Turn a scalar type to the corresponding object type.
 boolean canBeCalled()
          This predicate is used to test whether a given type can be used as the 'function' in a function call.
 JSType findPropertyType(String propertyName)
          Coerces this type to an Object type, then gets the type of the property whose name is given.
 FunctionType getConstructor()
          Gets this object's constructor.
 ObjectType getImplicitPrototype()
          Gets the implicit prototype (a.k.a.
 JSType getPrimitiveType()
          Gets the primitive type of this enum element.
 com.google.javascript.rhino.jstype.PropertyMap getPropertyMap()
          Returns the property map that manages the set of properties for an object.
 String getReferenceName()
          Gets the reference name for this object.
 int hashCode()
          If this is equal to a NamedType object, its hashCode must be equal to the hashCode of the NamedType object.
 boolean hasReferenceName()
          Returns true if the object is named.
 boolean isNominalType()
          Whether this type is a nominal type (a named instance object or a named enum).
 boolean isNullable()
          This predicate determines whether objects of this type can have the null value, and therefore can appear in contexts where null is expected.
 boolean isObject()
          Tests whether this type is an Object, or any subtype thereof.
 boolean isSubtype(JSType that)
          Checks whether this is a subtype of that.
 boolean matchesNumberContext()
          This predicate is used to test whether a given type can appear in a numeric context, such as an operand of a multiply operator.
 boolean matchesObjectContext()
          This predicate is used to test whether a given type can appear in an Object context, such as the expression in a with statement.
 boolean matchesStringContext()
          This predicate is used to test whether a given type can appear in a String context, such as an operand of a string concat (+) operator.
 TernaryValue testForEquality(JSType that)
          Compares this and that.
 EnumElementType toMaybeEnumElementType()
          Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType.
<T> T
visit(Visitor<T> visitor)
          Visit this type with the given visitor.
 
Methods inherited from class com.google.javascript.rhino.jstype.ObjectType
cast, clearCachedValues, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, getCtorExtendedInterfaces, getCtorImplementedInterfaces, getDisplayName, getJSDocInfo, getNormalizedReferenceName, getOwnerFunction, getOwnPropertyJSDocInfo, getOwnPropertyNames, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyNames, getPropertyNode, getPropertyType, getRootNode, getSlot, getTemplateTypes, getTypeOfThis, hasCachedValues, hasOwnProperty, hasProperty, isFunctionPrototypeType, isNativeObjectType, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isUnknownType, removeProperty, setJSDocInfo, setPropertyJSDocInfo
 
Methods inherited from class com.google.javascript.rhino.jstype.JSType
autobox, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, clearResolved, collapseUnion, dereference, differsFrom, equals, extendTemplateTypeMap, getGreatestSubtype, getLeastSupertype, getRestrictedTypeGivenToBooleanOutcome, getTemplateTypeMap, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, hasAnyTemplateTypes, hasDisplayName, isAllType, isArrayType, isBooleanObjectType, isBooleanValueType, isCheckedUnknownType, isConstructor, isDateType, isDict, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isFunctionType, isGlobalThisType, isInstanceType, isInterface, isInvariant, isNominalConstructor, isNoObjectType, isNoResolvedType, isNoType, isNullType, isNumber, isNumberObjectType, isNumberValueType, isOrdinaryFunction, isRecordType, isRegexpType, isResolved, isString, isStringObjectType, isStringValueType, isStruct, isTemplateType, isTemplatizedType, isUnionType, isVoidType, matchConstraint, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, setValidator, toAnnotationString, toDebugHashCodeString, toMaybeEnumType, toMaybeFunctionType, toMaybeFunctionType, toMaybeTemplateType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeTemplatizedType, toMaybeUnionType, toObjectType, toString, unboxesTo
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

getPropertyMap

public com.google.javascript.rhino.jstype.PropertyMap getPropertyMap()
Description copied from class: ObjectType
Returns the property map that manages the set of properties for an object.

toMaybeEnumElementType

public EnumElementType toMaybeEnumElementType()
Description copied from class: JSType
Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType.

Overrides:
toMaybeEnumElementType in class JSType

matchesNumberContext

public boolean matchesNumberContext()
Description copied from class: JSType
This predicate is used to test whether a given type can appear in a numeric context, such as an operand of a multiply operator.

Overrides:
matchesNumberContext in class JSType

matchesStringContext

public boolean matchesStringContext()
Description copied from class: JSType
This predicate is used to test whether a given type can appear in a String context, such as an operand of a string concat (+) operator. All types have at least the potential for converting to String. When we add externally defined types, such as a browser OM, we may choose to add types that do not automatically convert to String.

Overrides:
matchesStringContext in class JSType

matchesObjectContext

public boolean matchesObjectContext()
Description copied from class: JSType
This predicate is used to test whether a given type can appear in an Object context, such as the expression in a with statement. Most types we will encounter, except notably null, have at least the potential for converting to Object. Host defined objects can get peculiar.

Overrides:
matchesObjectContext in class JSType

canBeCalled

public boolean canBeCalled()
Description copied from class: JSType
This predicate is used to test whether a given type can be used as the 'function' in a function call.

Overrides:
canBeCalled in class JSType
Returns:
true if this type might be callable.

isObject

public boolean isObject()
Description copied from class: JSType
Tests whether this type is an Object, or any subtype thereof.

Overrides:
isObject in class ObjectType
Returns:
this &lt;: Object

testForEquality

public TernaryValue testForEquality(JSType that)
Description copied from class: JSType
Compares this and that.

Overrides:
testForEquality in class ObjectType
Returns:
  • TernaryValue.TRUE if the comparison of values of this type and that always succeed (such as undefined compared to null)
  • TernaryValue.FALSE if the comparison of values of this type and that always fails (such as undefined compared to number)
  • TernaryValue.UNKNOWN if the comparison can succeed or fail depending on the concrete values

isNullable

public boolean isNullable()
This predicate determines whether objects of this type can have the null value, and therefore can appear in contexts where null is expected.

Overrides:
isNullable in class JSType
Returns:
true for everything but Number and Boolean types.

isNominalType

public boolean isNominalType()
Description copied from class: JSType
Whether this type is a nominal type (a named instance object or a named enum).

Overrides:
isNominalType in class JSType

hashCode

public int hashCode()
If this is equal to a NamedType object, its hashCode must be equal to the hashCode of the NamedType object.

Overrides:
hashCode in class JSType

getReferenceName

public String getReferenceName()
Description copied from class: ObjectType
Gets the reference name for this object. This includes named types like constructors, prototypes, and enums. It notably does not include literal types like strings and booleans and structural types.

Specified by:
getReferenceName in class ObjectType
Returns:
the object's name or null if this is an anonymous object

hasReferenceName

public boolean hasReferenceName()
Description copied from class: ObjectType
Returns true if the object is named.

Overrides:
hasReferenceName in class ObjectType
Returns:
true if the object is named, false if it is anonymous

isSubtype

public boolean isSubtype(JSType that)
Description copied from class: JSType
Checks whether this is a subtype of that.

Subtyping rules:

Overrides:
isSubtype in class JSType
Returns:
this &lt;: that

visit

public <T> T visit(Visitor<T> visitor)
Description copied from class: JSType
Visit this type with the given visitor.

Overrides:
visit in class ObjectType
Returns:
the value returned by the visitor
See Also:
Visitor

getImplicitPrototype

public ObjectType getImplicitPrototype()
Description copied from class: ObjectType
Gets the implicit prototype (a.k.a. the [[Prototype]] property).

Specified by:
getImplicitPrototype in class ObjectType

findPropertyType

public JSType findPropertyType(String propertyName)
Description copied from class: JSType
Coerces this type to an Object type, then gets the type of the property whose name is given. Unlike ObjectType.getPropertyType(java.lang.String), returns null if the property is not found.

Overrides:
findPropertyType in class ObjectType
Returns:
The property's type. null if the current type cannot have properties, or if the type is not found.

getConstructor

public FunctionType getConstructor()
Description copied from class: ObjectType
Gets this object's constructor.

Specified by:
getConstructor in class ObjectType
Returns:
this object's constructor or null if it is a native object (constructed natively v.s. by instantiation of a function)

autoboxesTo

public JSType autoboxesTo()
Description copied from class: JSType
Turn a scalar type to the corresponding object type.

Overrides:
autoboxesTo in class JSType
Returns:
the auto-boxed type or null if this type is not a scalar.

getPrimitiveType

public JSType getPrimitiveType()
Gets the primitive type of this enum element.

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD