|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.javascript.rhino.jstype.JSType
com.google.javascript.rhino.jstype.ObjectType
com.google.javascript.rhino.jstype.EnumType
public class EnumType
An enum type representing a branded collection of elements. Each element
is referenced by its name, and has an EnumElementType
type.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.google.javascript.rhino.jstype.ObjectType |
---|
ObjectType.Property |
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, UNKNOWN_NAME |
Method Summary | ||
---|---|---|
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. |
|
JSDocInfo |
getOwnPropertyJSDocInfo(String propertyName)
Gets the docInfo on the specified property on this type. |
|
Set<String> |
getOwnPropertyNames()
Returns the names of all the properties directly on this type. |
|
int |
getPropertiesCount()
Gets the number of properties of this object. |
|
Node |
getPropertyNode(String propertyName)
Gets the node corresponding to the definition of the specified property. |
|
JSType |
getPropertyType(String property)
Gets the property type of the property whose name is given. |
|
String |
getReferenceName()
Gets the reference name for this object. |
|
ObjectType.Property |
getSlot(String name)
Returns any defined slot within this scope for this name. |
|
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 |
hasOwnProperty(String propertyName)
Checks whether the property whose name is given is present directly on the object. |
|
boolean |
hasProperty(String propertyName)
Checks whether the property whose name is given is present on the object. |
|
boolean |
hasReferenceName()
Returns true if the object is named. |
|
boolean |
isNativeObjectType()
Whether this is a built-in object. |
|
boolean |
isPropertyInExterns(String propertyName)
Checks whether the property was defined in the externs. |
|
boolean |
isPropertyTypeDeclared(String property)
Checks whether the property's type is declared. |
|
boolean |
isPropertyTypeInferred(String property)
Checks whether the property's type is inferred. |
|
boolean |
isSubtype(JSType that)
Checks whether this is a subtype of that . |
|
void |
matchConstraint(ObjectType constraintObj)
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. |
|
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()
Gets the type to which this type unboxes. |
|
|
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, findPropertyType, getIndexType, getJSDocInfo, getNormalizedReferenceName, getOwnSlot, getParameterType, getParentScope, getPossibleToBooleanOutcomes, getPropertyNames, getRootNode, getTypeOfThis, isFunctionPrototypeType, isObject, isUnknownType, setJSDocInfo |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
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 element
public 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 ObjectType.Property getSlot(String name)
StaticScope
getSlot
in interface StaticScope<JSType>
getSlot
in class ObjectType
name
- The name of the variable slot to look up.
null
if no
definition exists.public int getPropertiesCount()
getPropertiesCount
in class ObjectType
public boolean hasProperty(String propertyName)
ObjectType
hasProperty
in class ObjectType
public boolean hasOwnProperty(String propertyName)
ObjectType
hasOwnProperty
in class ObjectType
public Set<String> getOwnPropertyNames()
ObjectType
getOwnPropertyNames
in class ObjectType
public boolean isPropertyTypeDeclared(String property)
ObjectType
isPropertyTypeDeclared
in class ObjectType
public boolean isPropertyTypeInferred(String property)
ObjectType
isPropertyTypeInferred
in class ObjectType
public JSType getPropertyType(String property)
ObjectType
getPropertyType
in class ObjectType
UnknownType
. This method never
returns null
.public boolean isPropertyInExterns(String propertyName)
ObjectType
isPropertyInExterns
in class ObjectType
public boolean removeProperty(String name)
ObjectType
removeProperty
in class ObjectType
name
- the property's name
public Node getPropertyNode(String propertyName)
ObjectType
getPropertyNode
in class ObjectType
propertyName
- the name of the property
Node
corresponding to the property or null.public JSDocInfo getOwnPropertyJSDocInfo(String propertyName)
ObjectType
getOwnPropertyJSDocInfo
in class ObjectType
public 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
unboxesTo
in class JSType
null
if this type does not unbox.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(ObjectType constraintObj)
JSType
matchConstraint
in class JSType
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |