public class EnumElementType extends ObjectType
EnumType
).JSType.EqCache, JSType.ImplCache, JSType.MatchStatus, JSType.TypePair
Modifier and Type | Field and Description |
---|---|
private EnumType |
enumType |
private java.lang.String |
name |
private ObjectType |
primitiveObjectType |
private JSType |
primitiveType
The primitive type this enum element type wraps.
|
private static long |
serialVersionUID |
ALPHA, registry, templateTypeMap
Constructor and Description |
---|
EnumElementType(JSTypeRegistry registry,
JSType elementType,
java.lang.String name,
EnumType enumType) |
Modifier and Type | Method and Description |
---|---|
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.
|
(package private) boolean |
defineProperty(java.lang.String propertyName,
JSType type,
boolean inferred,
Node propertyNode)
Defines a property.
|
JSType |
findPropertyType(java.lang.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.
|
EnumType |
getEnumType() |
ObjectType |
getImplicitPrototype()
Gets the implicit prototype (a.k.a.
|
JSType |
getPrimitiveType()
Gets the primitive type of this enum element.
|
PropertyMap |
getPropertyMap()
Returns the property map that manages the set of properties for an object.
|
java.lang.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 . |
protected boolean |
isSubtype(JSType that,
JSType.ImplCache implicitImplCache)
checking isSubtype with structural interface matching
|
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. |
(package private) JSType |
meet(JSType that)
Returns the infimum of a enum element type and another type, or null
if the infimum is empty.
|
(package private) JSType |
resolveInternal(ErrorReporter t,
StaticTypedScope<JSType> scope) |
TernaryValue |
testForEquality(JSType that)
Compares
this and that . |
EnumElementType |
toMaybeEnumElementType()
Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType.
|
(package private) java.lang.String |
toStringHelper(boolean forAnnotations) |
(package private) <T> T |
visit(RelationshipVisitor<T> visitor,
JSType that)
Visit the types with the given visitor.
|
<T> T |
visit(Visitor<T> visitor)
Visit this type with the given visitor.
|
cast, checkStructuralEquivalenceHelper, clearCachedValues, collectPropertyNames, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, detectImplicitPrototypeCycle, detectInheritanceCycle, getCtorExtendedInterfaces, getCtorImplementedInterfaces, getDisplayName, getJSDocInfo, getNormalizedReferenceName, getOwnerFunction, getOwnPropertyJSDocInfo, getOwnPropertyNames, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyNames, getPropertyNode, getPropertyType, getPropertyTypeMap, getRootNode, getSlot, getTemplateTypes, getTypeOfThis, hasCachedValues, hasOwnDeclaredProperty, hasOwnProperty, hasProperty, isFunctionPrototypeType, isImplicitPrototype, isNativeObjectType, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isStructuralSubtype, isStructuralType, isUnknownType, removeProperty, setJSDocInfo, setOwnerFunction, setPropertyJSDocInfo, setPropertyNode
autobox, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, checkEquivalenceHelper, checkEquivalenceHelper, collapseUnion, dereference, differsFrom, equals, extendTemplateTypeMap, filterNoResolvedType, getGreatestSubtype, getGreatestSubtype, getLeastSupertype, getLeastSupertype, getNativeType, getRestrictedTypeGivenToBooleanOutcome, getTemplateTypeMap, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, hasAnyTemplateTypes, hasAnyTemplateTypesInternal, hasDisplayName, isAllType, isArrayType, isBooleanObjectType, isBooleanValueType, isBottom, isCheckedUnknownType, isConstructor, isDateType, isDict, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, isExemptFromTemplateTypeInvariance, isExplicitlyVoidable, isFunctionType, isGlobalThisType, isInstanceType, isInterface, isNamedType, isNominalConstructor, isNoObjectType, isNoResolvedType, isNoType, isNullType, isNumber, isNumberObjectType, isNumberValueType, isOrdinaryFunction, isRecordType, isRegexpType, isResolved, isString, isStringObjectType, isStringValueType, isStruct, isStructuralInterface, isSubtypeHelper, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTemplateType, isTemplatizedType, isTheObjectType, isUnionType, isVoidable, isVoidType, matchConstraint, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, safeResolve, setResolvedTypeInternal, setValidator, testForEqualityHelper, toAnnotationString, toDebugHashCodeString, toMaybeEnumType, toMaybeFunctionType, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toMaybeRecordType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeUnionType, toNonNullAnnotationString, toObjectType, toString, unboxesTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
isBottom, isConstructor, isEquivalentTo, isFunctionType, isInterface, isSubtypeOf, restrictByNotNullOrUndefined, toMaybeFunctionType, toMaybeObjectType
private static final long serialVersionUID
private JSType primitiveType
LOCAL_CODES
enum
var LOCAL_CODES = {A: 3, B: 9, C: 8}the primitive type of the the constants is
number
.private ObjectType primitiveObjectType
private final java.lang.String name
private final EnumType enumType
EnumElementType(JSTypeRegistry registry, JSType elementType, java.lang.String name, EnumType enumType)
public EnumType getEnumType()
public PropertyMap getPropertyMap()
ObjectType
getPropertyMap
in class ObjectType
public EnumElementType toMaybeEnumElementType()
JSType
toMaybeEnumElementType
in class JSType
public boolean matchesNumberContext()
JSType
matchesNumberContext
in class JSType
public boolean matchesStringContext()
JSType
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
.matchesStringContext
in class JSType
public boolean matchesObjectContext()
JSType
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.matchesObjectContext
in class JSType
public boolean canBeCalled()
JSType
canBeCalled
in class JSType
true
if this type might be callable.public boolean isObject()
JSType
Object
, or any subtype thereof.isObject
in class ObjectType
this <: Object
public TernaryValue testForEquality(JSType that)
JSType
this
and that
.testForEquality
in class ObjectType
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 valuespublic boolean isNullable()
isNullable
in class JSType
public boolean isNominalType()
JSType
isNominalType
in class JSType
public int hashCode()
java.lang.String toStringHelper(boolean forAnnotations)
toStringHelper
in class JSType
forAnnotations
- Whether this is for use in code generator
annotations. Otherwise, it's for warnings.public java.lang.String getReferenceName()
ObjectType
getReferenceName
in class ObjectType
null
if this is an anonymous
objectpublic boolean hasReferenceName()
ObjectType
hasReferenceName
in class ObjectType
public boolean isSubtype(JSType that)
JSType
this
is a subtype of that
.Note this function also returns true if this type structurally matches the protocol define by that type (if that type is an interface function type) Subtyping rules:
(T1, …, Tn) <: U
if and only
Tk <: U
for all k ∈ 1..n
.U <: (T1, …, Tn)
if and only
if U <: Tk
for some index k
.O1
is a subtype
of an object O2
if it has more properties
than O2
and all common properties are
pairwise subtypes.protected boolean isSubtype(JSType that, JSType.ImplCache implicitImplCache)
JSType
public <T> T visit(Visitor<T> visitor)
JSType
visit
in class ObjectType
Visitor
<T> T visit(RelationshipVisitor<T> visitor, JSType that)
JSType
visit
in class ObjectType
RelationshipVisitor
boolean defineProperty(java.lang.String propertyName, JSType type, boolean inferred, Node propertyNode)
ObjectType
For clarity, callers should prefer ObjectType.defineDeclaredProperty(java.lang.String, com.google.javascript.rhino.jstype.JSType, com.google.javascript.rhino.Node)
and
ObjectType.defineInferredProperty(java.lang.String, com.google.javascript.rhino.jstype.JSType, com.google.javascript.rhino.Node)
.
defineProperty
in class ObjectType
propertyName
- the property's nametype
- the typeinferred
- true
if this property's type is inferredpropertyNode
- the node that represents the definition of property.
Depending on the actual sub-type the node type might be different.
The general idea is to have an estimate of where in the source code
this property is defined.public ObjectType getImplicitPrototype()
ObjectType
[[Prototype]]
property).getImplicitPrototype
in class ObjectType
public JSType findPropertyType(java.lang.String propertyName)
JSType
ObjectType.getPropertyType(java.lang.String)
, returns null if the property
is not found.findPropertyType
in class ObjectType
null
if the current type cannot
have properties, or if the type is not found.public FunctionType getConstructor()
ObjectType
getConstructor
in interface ObjectTypeI
getConstructor
in class ObjectType
null
if it is a native
object (constructed natively v.s. by instantiation of a function)public JSType autoboxesTo()
JSType
autoboxesTo
in class JSType
null
if this type is not a scalar.public JSType getPrimitiveType()
JSType meet(JSType that)
JSType resolveInternal(ErrorReporter t, StaticTypedScope<JSType> scope)