Class EnumType
java.lang.Object
com.google.javascript.rhino.jstype.JSType
com.google.javascript.rhino.jstype.ObjectType
com.google.javascript.rhino.jstype.EnumType
- All Implemented Interfaces:
StaticScope<JSType>
,Serializable
An enum type representing a branded collection of elements. Each element
is referenced by its name, and has an
EnumElementType
type.- 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 TypeMethodDescriptionboolean
This predicate is used to test whether a given type can be used as the 'function' in a function call.boolean
defineElement
(String name, Node definingNode) Defines a new element on this enum.Gets this object's constructor.Gets the interfaces extended by the interface associated with this type.Gets the interfaces implemented by the ctor associated with this type.Returns a user meaningful label for the JSType instance.Gets the elements defined on this enum.Gets the elements' type.Gets the implicit prototype (a.k.a.Gets the owner of this if it's a function prototype.Gets the reference name for this object.Gets the source node or null if this is an unknown enum.boolean
Returns true if any cached values have been set for this type.boolean
Returns true if the object is named.boolean
Whether this is a built-in object.boolean
Checks whetherthis
is a subtype ofthat
.void
matchConstraint
(JSType constraint) Modify this type so that it matches the specified type.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.void
matchRecordTypeConstraint
(ObjectType constraintObj) boolean
removeProperty
(String name) Removes the declared or inferred property from this ObjectType.void
setPropertyJSDocInfo
(String propertyName, JSDocInfo info) Sets the docInfo for the specified property from theJSDocInfo
on its definition.testForEquality
(JSType that) Comparesthis
andthat
.Downcasts this to an EnumType, or returns null if this is not an EnumType.Turn an object type to its corresponding scalar type.<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, findPropertyType, getJSDocInfo, getNormalizedReferenceName, getOwnPropertyJSDocInfo, getOwnPropertyNames, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyNames, getPropertyNode, getPropertyType, getRootNode, getSlot, getTemplateTypes, getTypeOfThis, hasOwnProperty, hasProperty, isFunctionPrototypeType, isObject, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isUnknownType, setJSDocInfo
Methods inherited from class com.google.javascript.rhino.jstype.JSType
autobox, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, clearResolved, collapseUnion, dereference, differsFrom, equals, forceResolve, getGreatestSubtype, getLeastSupertype, getRestrictedTypeGivenToBooleanOutcome, getTemplateTypeMap, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, hasAnyTemplateTypes, hasDisplayName, hashCode, isAllType, isArrayType, isBooleanObjectType, isBooleanValueType, isCheckedUnknownType, isConstructor, isDateType, isDict, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isFunctionType, isGlobalThisType, isInstanceType, isInterface, isInvariant, isNominalConstructor, isNominalType, isNoObjectType, isNoResolvedType, isNoType, isNullable, isNullType, isNumber, isNumberObjectType, isNumberValueType, isOrdinaryFunction, isRecordType, isRegexpType, isResolved, isString, isStringObjectType, isStringValueType, isStruct, isTemplateType, isTemplatizedType, isUnionType, isVoidType, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, setValidator, toAnnotationString, toDebugHashCodeString, toMaybeEnumElementType, toMaybeFunctionType, toMaybeFunctionType, toMaybeTemplateType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeTemplatizedType, toMaybeUnionType, toObjectType, toString
-
Method Details
-
getSource
Gets the source node or null if this is an unknown enum. -
toMaybeEnumType
Description copied from class:JSType
Downcasts this to an EnumType, or returns null if this is not an EnumType.- Overrides:
toMaybeEnumType
in classJSType
-
getImplicitPrototype
Description copied from class:ObjectType
Gets the implicit prototype (a.k.a. the[[Prototype]]
property). -
getElements
Gets the elements defined on this enum.- Returns:
- the elements' names defined on this enum. The returned set is immutable.
-
defineElement
Defines a new element on this enum.- Parameters:
name
- the name of the new elementdefiningNode
- theNode
that defines this new element- Returns:
- true iff the new element is added successfully
-
getElementsType
Gets the elements' type. -
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
-
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.
- Returns:
this <: that
-
getDisplayName
Description copied from class:JSType
Returns a user meaningful label for the JSType instance. For example, Functions and Enums will return their declaration name (if they have one). Some types will not have a meaningful display name. Calls to hasDisplayName() will return true IFF getDisplayName() will return null or a zero length string.- Overrides:
getDisplayName
in classObjectType
- Returns:
- the display name of the type, or null if one is not available
-
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:
-
getConstructor
Description copied from class:ObjectType
Gets this object's constructor.- Returns:
- this object's constructor or
null
if it is a native object (constructed natively v.s. by instantiation of a function)
-
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. -
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
. -
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. -
removeProperty
Description copied from class:ObjectType
Removes the declared or inferred property from this ObjectType.- Overrides:
removeProperty
in classObjectType
- Parameters:
name
- the property's name- Returns:
- true if the property was removed successfully. False if the property did not exist, or could not be removed.
-
setPropertyJSDocInfo
Description copied from class:ObjectType
Sets the docInfo for the specified property from theJSDocInfo
on its definition.- Overrides:
setPropertyJSDocInfo
in classObjectType
info
-JSDocInfo
for the property definition. May benull
.
-
unboxesTo
Description copied from class:JSType
Turn an object type to its corresponding scalar type. -
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.
-
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
-
hasCachedValues
public boolean hasCachedValues()Description copied from class:ObjectType
Returns true if any cached values have been set for this type. If true, then the prototype chain should not be changed, as it might invalidate the cached values.- Overrides:
hasCachedValues
in classObjectType
-
isNativeObjectType
public boolean isNativeObjectType()Whether this is a built-in object.- Overrides:
isNativeObjectType
in classObjectType
-
getOwnerFunction
Description copied from class:ObjectType
Gets the owner of this if it's a function prototype.- Overrides:
getOwnerFunction
in classObjectType
-
getCtorImplementedInterfaces
Description copied from class:ObjectType
Gets the interfaces implemented by the ctor associated with this type. Intended to be overridden by subclasses.- Overrides:
getCtorImplementedInterfaces
in classObjectType
-
getCtorExtendedInterfaces
Description copied from class:ObjectType
Gets the interfaces extended by the interface associated with this type. Intended to be overridden by subclasses.- Overrides:
getCtorExtendedInterfaces
in classObjectType
-
matchConstraint
Description copied from class:JSType
Modify this type so that it matches the specified type. This is useful for reverse type-inference, where we want to infer that an object literal matches its constraint (much like how the java compiler does reverse-inference to figure out generics).- Overrides:
matchConstraint
in classJSType
-
matchRecordTypeConstraint
-