Class EnumElementType
java.lang.Object
com.google.javascript.rhino.jstype.JSType
com.google.javascript.rhino.jstype.ObjectType
com.google.javascript.rhino.jstype.EnumElementType
- All Implemented Interfaces:
StaticScope<JSType>
,Serializable
The type of individual elements of an enum type
(see
EnumType
).- See Also:
-
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
Modifier and TypeMethodDescriptionTurn a scalar type to the corresponding object type.boolean
This predicate is used to test whether a given type can be used as the 'function' in a function call.findPropertyType
(String propertyName) Coerces this type to an Object type, then gets the type of the property whose name is given.Gets this object's constructor.Gets the implicit prototype (a.k.a.Gets the primitive type of this enum element.com.google.javascript.rhino.jstype.PropertyMap
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
Returns true if the object is named.boolean
Whether this type is a nominal type (a named instance object or a named enum).boolean
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 anObject
, or any subtype thereof.boolean
Checks whetherthis
is a subtype ofthat
.boolean
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
This predicate is used to test whether a given type can appear in anObject
context, such as the expression in a with statement.boolean
This predicate is used to test whether a given type can appear in aString
context, such as an operand of a string concat (+) operator.testForEquality
(JSType that) Comparesthis
andthat
.Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType.<T> T
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, forceResolve, 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
-
Method Details
-
getPropertyMap
public com.google.javascript.rhino.jstype.PropertyMap getPropertyMap() -
toMaybeEnumElementType
Description copied from class:JSType
Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType.- Overrides:
toMaybeEnumElementType
in classJSType
-
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 classJSType
-
matchesStringContext
public boolean matchesStringContext()Description copied from class:JSType
This predicate is used to test whether a given type can appear in aString
context, such as an operand of a string concat (+) operator. All types have at least the potential for converting toString
. When we add externally defined types, such as a browser OM, we may choose to add types that do not automatically convert toString
.- Overrides:
matchesStringContext
in classJSType
-
matchesObjectContext
public boolean matchesObjectContext()Description copied from class:JSType
This predicate is used to test whether a given type can appear in anObject
context, such as the expression in a with statement. Most types we will encounter, except notablynull
, have at least the potential for converting toObject
. Host defined objects can get peculiar.- Overrides:
matchesObjectContext
in classJSType
-
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 classJSType
- Returns:
true
if this type might be callable.
-
isObject
public boolean isObject()Description copied from class:JSType
Tests whether this type is anObject
, or any subtype thereof.- Overrides:
isObject
in classObjectType
- Returns:
this <: Object
-
testForEquality
Description copied from class:JSType
Comparesthis
andthat
.- Overrides:
testForEquality
in classObjectType
- Returns:
TernaryValue.TRUE
if the comparison of values ofthis
type andthat
always succeed (such asundefined
compared tonull
)TernaryValue.FALSE
if the comparison of values ofthis
type andthat
always fails (such asundefined
compared tonumber
)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 classJSType
- 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 classJSType
-
hashCode
public int hashCode()If this is equal to a NamedType object, its hashCode must be equal to the hashCode of the NamedType object. -
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 classObjectType
- 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 classObjectType
- Returns:
- true if the object is named, false if it is anonymous
-
isSubtype
Description copied from class:JSType
Checks whetherthis
is a subtype ofthat
.Subtyping rules:
- (unknown) — every type is a subtype of the Unknown type.
- (no) — the No type is a subtype of every type.
- (no-object) — the NoObject type is a subtype of every object type (i.e. subtypes of the Object type).
- (ref) — a type is a subtype of itself.
- (union-l) — A union type is a subtype of a type U if all the
union type's constituents are a subtype of U. Formally
(T<sub>1</sub>, …, T<sub>n</sub>) <: U
if and onlyT<sub>k</sub> <: U
for allk ∈ 1..n
. - (union-r) — A type U is a subtype of a union type if it is a
subtype of one of the union type's constituents. Formally
U <: (T<sub>1</sub>, …, T<sub>n</sub>)
if and only ifU <: T<sub>k</sub>
for some indexk
. - (objects) — an Object
O<sub>1</sub>
is a subtype of an objectO<sub>2</sub>
if it has more properties thanO<sub>2</sub>
and all common properties are pairwise subtypes.
-
visit
Description copied from class:JSType
Visit this type with the given visitor.- Overrides:
visit
in classObjectType
- Returns:
- the value returned by the visitor
- See Also:
-
getImplicitPrototype
Description copied from class:ObjectType
Gets the implicit prototype (a.k.a. the[[Prototype]]
property).- Specified by:
getImplicitPrototype
in classObjectType
-
findPropertyType
Description copied from class:JSType
Coerces this type to an Object type, then gets the type of the property whose name is given. UnlikeObjectType.getPropertyType(java.lang.String)
, returns null if the property is not found.- Overrides:
findPropertyType
in classObjectType
- Returns:
- The property's type.
null
if the current type cannot have properties, or if the type is not found.
-
getConstructor
Description copied from class:ObjectType
Gets this object's constructor.- Specified by:
getConstructor
in classObjectType
- Returns:
- this object's constructor or
null
if it is a native object (constructed natively v.s. by instantiation of a function)
-
autoboxesTo
Description copied from class:JSType
Turn a scalar type to the corresponding object type.- Overrides:
autoboxesTo
in classJSType
- Returns:
- the auto-boxed type or
null
if this type is not a scalar.
-
getPrimitiveType
Gets the primitive type of this enum element.
-