|
|||||||||
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.TemplatizedType
public final class TemplatizedType
An object type with declared template types, such as
Array.
.
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 | ||
---|---|---|
boolean |
canBeCalled()
This predicate is used to test whether a given type can be used as the 'function' in a function call. |
|
JSType |
collapseUnion()
Gets the least supertype of this that's not a union. |
|
JSType |
findPropertyType(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. |
|
Iterable<ObjectType> |
getCtorImplementedInterfaces()
Gets the interfaces implemented by the ctor associated with this type. |
|
ObjectType |
getImplicitPrototype()
Gets the implicit prototype (a.k.a. |
|
JSDocInfo |
getJSDocInfo()
Gets the docInfo for this type. |
|
FunctionType |
getOwnerFunction()
Gets the owner of this if it's a function prototype. |
|
ObjectType |
getReferencedType()
|
|
String |
getReferenceName()
Gets the reference name for this object. |
|
TemplateTypeMap |
getTemplateTypeMap()
Returns the template type map associated with this type. |
|
com.google.common.collect.ImmutableList<JSType> |
getTemplateTypes()
Gets the declared default element type. |
|
JSType |
getTypeOfThis()
Returns the expected type of this in the current scope. |
|
boolean |
hasAnyTemplateTypesInternal()
|
|
int |
hashCode()
|
|
boolean |
hasReferenceName()
Returns true if the object is named. |
|
boolean |
isAllType()
|
|
boolean |
isCheckedUnknownType()
|
|
boolean |
isConstructor()
Whether this type is a FunctionType that is a constructor or a
named type that points to such a type. |
|
boolean |
isDict()
Returns true iff this can be a dict . |
|
boolean |
isInstanceType()
Whether this type is an Instance object of some constructor. |
|
boolean |
isInterface()
Whether this type is a FunctionType that is an interface or a named
type that points to such a type. |
|
boolean |
isNativeObjectType()
Whether this is a built-in object. |
|
boolean |
isNominalType()
Whether this type is a nominal type (a named instance object or a named enum). |
|
boolean |
isNoObjectType()
|
|
boolean |
isNoResolvedType()
|
|
boolean |
isNoType()
|
|
boolean |
isNullable()
Tests whether this type is nullable. |
|
boolean |
isOrdinaryFunction()
Whether this type is a FunctionType that is an ordinary function or
a named type that points to such a type. |
|
boolean |
isStruct()
Returns true iff this can be a struct . |
|
boolean |
isSubtype(JSType that)
Checks whether this is a subtype of that . |
|
boolean |
isUnknownType()
We treat this as the unknown type if any of its implicit prototype properties is unknown. |
|
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. |
|
boolean |
removeProperty(String name)
Removes the declared or inferred property from this ObjectType. |
|
void |
setJSDocInfo(JSDocInfo info)
Sets the docInfo for this type from the given JSDocInfo . |
|
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 . |
|
String |
toDebugHashCodeString()
A hash code function for diagnosing complicated issues around type-identity. |
|
EnumElementType |
toMaybeEnumElementType()
Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType. |
|
EnumType |
toMaybeEnumType()
Downcasts this to an EnumType, or returns null if this is not an EnumType. |
|
FunctionType |
toMaybeFunctionType()
Downcasts this to a FunctionType, or returns null if this is not a function. |
|
TemplateType |
toMaybeTemplateType()
Downcasts this to a TemplateType, or returns null if this is not a function. |
|
TemplatizedType |
toMaybeTemplatizedType()
Downcasts this to a TemplatizedType, or returns null if this is not a function. |
|
UnionType |
toMaybeUnionType()
Downcasts this to a UnionType, or returns null if this is not a UnionType. |
|
|
visit(Visitor<T> visitor)
Visit this type with the given visitor. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public <T> T visit(Visitor<T> visitor)
JSType
Visitor
public TemplatizedType toMaybeTemplatizedType()
JSType
public com.google.common.collect.ImmutableList<JSType> getTemplateTypes()
ObjectType
TemplatizedType
public 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 TemplateTypeMap getTemplateTypeMap()
JSType
public boolean hasAnyTemplateTypesInternal()
public ObjectType getReferencedType()
public String getReferenceName()
ObjectType
getReferenceName
in class ObjectType
null
if this is an anonymous
objectpublic boolean hasReferenceName()
ObjectType
hasReferenceName
in class ObjectType
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 isNoType()
isNoType
in class JSType
public boolean isNoObjectType()
isNoObjectType
in class JSType
public boolean isNoResolvedType()
isNoResolvedType
in class JSType
public boolean isUnknownType()
ObjectType
isUnknownType
in class ObjectType
public boolean isCheckedUnknownType()
isCheckedUnknownType
in class JSType
public boolean isNullable()
JSType
isNullable
in class JSType
public EnumType toMaybeEnumType()
JSType
toMaybeEnumType
in class JSType
public boolean isConstructor()
JSType
FunctionType
that is a constructor or a
named type that points to such a type.
isConstructor
in class JSType
public boolean isNominalType()
JSType
isNominalType
in class JSType
public boolean isInstanceType()
JSType
InstanceObjectType
.
isInstanceType
in class JSType
public boolean isInterface()
JSType
FunctionType
that is an interface or a named
type that points to such a type.
isInterface
in class JSType
public boolean isOrdinaryFunction()
JSType
FunctionType
that is an ordinary function or
a named type that points to such a type.
isOrdinaryFunction
in class JSType
public boolean isAllType()
isAllType
in class JSType
public boolean isStruct()
JSType
this
can be a struct
.
UnionType overrides the method, assume this
is not a union here.
isStruct
in class JSType
public boolean isDict()
JSType
this
can be a dict
.
UnionType overrides the method, assume this
is not a union here.
isDict
in class JSType
public boolean isNativeObjectType()
ObjectType
isNativeObjectType
in class ObjectType
public UnionType toMaybeUnionType()
JSType
toMaybeUnionType
in class JSType
public FunctionType toMaybeFunctionType()
JSType
toMaybeFunctionType
in class JSType
public EnumElementType toMaybeEnumElementType()
JSType
toMaybeEnumElementType
in class JSType
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 FunctionType getOwnerFunction()
ObjectType
getOwnerFunction
in class ObjectType
public Iterable<ObjectType> getCtorImplementedInterfaces()
ObjectType
getCtorImplementedInterfaces
in class ObjectType
public int hashCode()
hashCode
in class JSType
public ObjectType getImplicitPrototype()
ObjectType
[[Prototype]]
property).
getImplicitPrototype
in class ObjectType
public boolean removeProperty(String name)
ObjectType
removeProperty
in class ObjectType
name
- the property's name
public JSType findPropertyType(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 JSDocInfo getJSDocInfo()
ObjectType
getJSDocInfo
in class ObjectType
public void setJSDocInfo(JSDocInfo info)
ObjectType
JSDocInfo
. The JSDocInfo
may be null
.
setJSDocInfo
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 FunctionType getConstructor()
ObjectType
getConstructor
in class ObjectType
null
if it is a native
object (constructed natively v.s. by instantiation of a function)public String toDebugHashCodeString()
JSType
toDebugHashCodeString
in class JSType
public JSType getTypeOfThis()
StaticScope
this
in the current scope.
getTypeOfThis
in interface StaticScope<JSType>
getTypeOfThis
in class ObjectType
public JSType collapseUnion()
JSType
collapseUnion
in class JSType
public void matchConstraint(JSType constraint)
JSType
matchConstraint
in class JSType
public TemplateType toMaybeTemplateType()
JSType
toMaybeTemplateType
in class JSType
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |