public class EnumType extends ObjectType
EnumElementType
type.JSType.TypePair
EMPTY_TYPE_COMPONENT, ENUMDECL, NOT_A_CLASS, NOT_A_TYPE, NOT_ENUMDECL, templateTypeMap, UNKNOWN_NAME
Modifier and Type | Method and Description |
---|---|
boolean |
canBeCalled()
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.
|
FunctionType |
getConstructor()
Gets this object's constructor.
|
Iterable<ObjectType> |
getCtorExtendedInterfaces()
Gets the interfaces extended by the interface associated with this type.
|
Iterable<ObjectType> |
getCtorImplementedInterfaces()
Gets the interfaces implemented by the ctor associated with this type.
|
String |
getDisplayName()
Returns a user meaningful label for the JSType instance.
|
Set<String> |
getElements()
Gets the elements defined on this enum.
|
EnumElementType |
getElementsType()
Gets the elements' type.
|
ObjectType |
getImplicitPrototype()
Gets the implicit prototype (a.k.a.
|
FunctionType |
getOwnerFunction()
Gets the owner of this if it's a function prototype.
|
String |
getReferenceName()
Gets the reference name for this object.
|
Node |
getSource()
Gets the source node or null if this is an unknown enum.
|
boolean |
hasCachedValues()
Returns true if any cached values have been set for this type.
|
boolean |
hasReferenceName()
Returns true if the object is named.
|
boolean |
isNativeObjectType()
Whether this is a built-in object.
|
boolean |
isSubtype(JSType that)
Checks whether
this is a subtype of that . |
void |
matchConstraint(JSType constraint)
Modify this type so that it matches the specified type.
|
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. |
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 the
JSDocInfo on its definition. |
TernaryValue |
testForEquality(JSType that)
Compares
this and that . |
EnumType |
toMaybeEnumType()
Downcasts this to an EnumType, or returns null if this is not an EnumType.
|
JSType |
unboxesTo()
Turn an object type to its corresponding scalar type.
|
<T> T |
visit(Visitor<T> visitor)
Visit this type with the given visitor.
|
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
autobox, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, clearResolved, collapseUnion, dereference, differsFrom, equals, extendTemplateTypeMap, 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
public Node getSource()
public EnumType toMaybeEnumType()
JSType
toMaybeEnumType
in class JSType
public ObjectType getImplicitPrototype()
ObjectType
[[Prototype]]
property).public Set<String> getElements()
public boolean defineElement(String name, Node definingNode)
name
- the name of the new elementdefiningNode
- the Node
that defines this new elementpublic EnumElementType getElementsType()
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 isSubtype(JSType that)
JSType
this
is a subtype of that
.Subtyping rules:
(T<sub>1</sub>, …, T<sub>n</sub>) <: U
if and only
T<sub>k</sub> <: U
for all k ∈ 1..n
.U <: (T<sub>1</sub>, …, T<sub>n</sub>)
if and only
if U <: T<sub>k</sub>
for some index k
.O<sub>1</sub>
is a subtype
of an object O<sub>2</sub>
if it has more properties
than O<sub>2</sub>
and all common properties are
pairwise subtypes.this <: that
public String getDisplayName()
JSType
getDisplayName
in class ObjectType
public <T> T visit(Visitor<T> visitor)
JSType
visit
in class ObjectType
Visitor
public FunctionType getConstructor()
ObjectType
null
if it is a native
object (constructed natively v.s. by instantiation of a function)public boolean matchesNumberContext()
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
.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.public boolean removeProperty(String name)
ObjectType
removeProperty
in class ObjectType
name
- the property's namepublic void setPropertyJSDocInfo(String propertyName, JSDocInfo info)
ObjectType
JSDocInfo
on its definition.setPropertyJSDocInfo
in class ObjectType
info
- JSDocInfo
for the property definition. May be
null
.public JSType unboxesTo()
JSType
public boolean canBeCalled()
JSType
canBeCalled
in class JSType
true
if this type might be callable.public String getReferenceName()
ObjectType
getReferenceName
in class ObjectType
null
if this is an anonymous
objectpublic boolean hasReferenceName()
ObjectType
hasReferenceName
in class ObjectType
public boolean hasCachedValues()
ObjectType
hasCachedValues
in class ObjectType
public boolean isNativeObjectType()
isNativeObjectType
in class ObjectType
public FunctionType getOwnerFunction()
ObjectType
getOwnerFunction
in class ObjectType
public Iterable<ObjectType> getCtorImplementedInterfaces()
ObjectType
getCtorImplementedInterfaces
in class ObjectType
public Iterable<ObjectType> getCtorExtendedInterfaces()
ObjectType
getCtorExtendedInterfaces
in class ObjectType
public void matchConstraint(JSType constraint)
JSType
matchConstraint
in class JSType
public void matchRecordTypeConstraint(ObjectType constraintObj)
Copyright © 2009–2014 Google. All rights reserved.