|
|||||||||
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.FunctionType
com.google.javascript.rhino.jstype.NoObjectType
public class NoObjectType
The bottom Object type, representing the subclass of all objects.
Although JavaScript programmers can't explicitly denote the bottom
Object type, it comes up in static analysis. For example, if we have:
var x = function() {};
if (x instanceof Array) {
f(x);
}
We need to be able to assign x
a type within the f(x)
call. It has no possible type, but x
would not be legal if f
expected a string. So we assign it the NoObjectType
.
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 | ||
---|---|---|
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. |
|
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. |
|
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 propertyName)
Gets the property type of the property whose name is given. |
|
String |
getReferenceName()
Gets the reference name for this object. |
|
int |
hashCode()
|
|
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 |
isEquivalentTo(JSType that)
Two function types are equal if their signatures match. |
|
boolean |
isNativeObjectType()
Whether this is a built-in object. |
|
boolean |
isNoObjectType()
|
|
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 propertyName)
Checks whether the property's type is inferred. |
|
boolean |
isSubtype(JSType that)
A function is a subtype of another if their call methods are related via subtyping and this is a subtype of that with regard to
the prototype chain. |
|
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. |
|
FunctionType |
toMaybeFunctionType()
Downcasts this to a FunctionType, or returns null if this is not a function. |
|
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, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, findPropertyType, getDisplayName, getIndexType, getJSDocInfo, getNormalizedReferenceName, getOwnSlot, getParameterType, getParentScope, getPossibleToBooleanOutcomes, getPropertyNames, getRootNode, isFunctionPrototypeType, isObject, isUnknownType, setJSDocInfo, testForEquality |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public boolean isSubtype(JSType that)
FunctionType
this
is a subtype of that
with regard to
the prototype chain.
isSubtype
in class FunctionType
this <: that
public FunctionType toMaybeFunctionType()
JSType
toMaybeFunctionType
in class FunctionType
public boolean isNoObjectType()
isNoObjectType
in class JSType
public ObjectType getImplicitPrototype()
ObjectType
[[Prototype]]
property).
public String getReferenceName()
ObjectType
null
if this is an anonymous
objectpublic boolean matchesNumberContext()
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.
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 isEquivalentTo(JSType that)
FunctionType
isEquivalentTo
in class FunctionType
public int hashCode()
hashCode
in class FunctionType
public int getPropertiesCount()
public JSType getPropertyType(String propertyName)
ObjectType
getPropertyType
in class FunctionType
UnknownType
. This method never
returns null
.public boolean hasProperty(String propertyName)
ObjectType
public boolean removeProperty(String name)
ObjectType
name
- the property's name
public JSDocInfo getOwnPropertyJSDocInfo(String propertyName)
ObjectType
public void setPropertyJSDocInfo(String propertyName, JSDocInfo info)
ObjectType
JSDocInfo
on its definition.
info
- JSDocInfo
for the property definition. May be
null
.public boolean isPropertyTypeInferred(String propertyName)
ObjectType
public <T> T visit(Visitor<T> visitor)
JSType
visit
in class FunctionType
Visitor
public FunctionType getConstructor()
ObjectType
null
if it is a native
object (constructed natively v.s. by instantiation of a function)public boolean hasOwnProperty(String propertyName)
ObjectType
hasOwnProperty
in class ObjectType
public boolean isPropertyTypeDeclared(String property)
ObjectType
isPropertyTypeDeclared
in class ObjectType
public boolean isPropertyInExterns(String propertyName)
ObjectType
isPropertyInExterns
in class ObjectType
public Node getPropertyNode(String propertyName)
ObjectType
getPropertyNode
in class ObjectType
propertyName
- the name of the property
Node
corresponding to the property or null.public JSType unboxesTo()
JSType
unboxesTo
in class JSType
null
if this type does not unbox.public boolean hasReferenceName()
ObjectType
hasReferenceName
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 |