com.google.javascript.rhino.jstype

Class NoObjectType

java.lang.Object

com.google.javascript.rhino.jstype.JSType

com.google.javascript.rhino.jstype.ObjectType

com.google.javascript.rhino.jstype.PrototypeObjectType

com.google.javascript.rhino.jstype.FunctionType

com.google.javascript.rhino.jstype.NoObjectType

All Implemented Interfaces:

FunctionTypeI, ObjectTypeI, TypeI, java.io.Serializable

Direct Known Subclasses:

NoType

public class NoObjectType
extends FunctionType

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.

See Also:

Bottom types, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.google.javascript.rhino.jstype.JSType

JSType.EqCache, JSType.ImplCache, JSType.MatchStatus, JSType.TypePair

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID

Fields inherited from class com.google.javascript.rhino.jstype.JSType

ALPHA, registry, templateTypeMap

Constructor Summary

Constructors

Constructor and Description
NoObjectType(JSTypeRegistry registry)

Method Summary

Modifier and Type	Method and Description
(package private) boolean	defineProperty(java.lang.String propertyName, JSType type, boolean inferred, Node propertyNode) Defines a property.
FunctionType	getConstructor() Gets this object's constructor.
ObjectType	getImplicitPrototype() Gets the implicit prototype (a.k.a.
java.lang.String	getReferenceName() Gets the reference name for this object.
int	hashCode()
boolean	hasReferenceName() Returns true if the object is named.
boolean	isNoObjectType()
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.
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.
boolean	removeProperty(java.lang.String name) Removes the declared or inferred property from this ObjectType.
(package private) JSType	resolveInternal(ErrorReporter t, StaticTypedScope<JSType> scope)
void	setPropertyJSDocInfo(java.lang.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.
(package private) java.lang.String	toStringHelper(boolean forAnnotations) Informally, a function is represented by function (params): returnType where the params is a comma separated list of types, the first one being a special this:T if the function expects a known type for this.
(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.

Methods inherited from class com.google.javascript.rhino.jstype.FunctionType

addSubTypeIfNotPresent, canBeCalled, checkExtendsLoop, checkExtendsLoop, checkFunctionEquivalenceHelper, clearCachedValues, convertMethodToFunction, explicitlyImplOrExtInterface, extendTemplateTypeMapBasedOn, forgetParameterAndReturnTypes, forInterface, getAllImplementedInterfaces, getBindReturnType, getExtendedInterfaces, getExtendedInterfacesCount, getImplementedInterfaces, getInstanceType, getInternalArrowType, getMaxArguments, getMinArguments, getOwnImplementedInterfaces, getOwnPropertyNames, getParameters, getParametersNode, getPropertyType, getPropertyTypeMap, getPrototype, getReturnType, getSlot, getSource, getSubTypes, getSuperClassConstructor, getTopDefiningInterface, getTopMostDefiningType, getTypeOfThis, hasAnyTemplateTypesInternal, hasCachedValues, hasEqualCallType, hasImplementedInterfaces, hasInstanceType, hasProperties, isConstructor, isInstanceType, isInterface, isOrdinaryFunction, isReturnTypeInferred, isStructuralInterface, makesDicts, makesStructs, setDict, setExtendedInterfaces, setImplementedInterfaces, setImplicitMatch, setInstanceType, setPrototype, setPrototypeBasedOn, setPrototypeBasedOn, setSource, setStruct, supAndInfHelper, toDebugHashCodeString, treatThisTypesAsCovariant

Methods inherited from class com.google.javascript.rhino.jstype.PrototypeObjectType

getCtorExtendedInterfaces, getCtorImplementedInterfaces, getOwnerFunction, getPropertyMap, isAnonymous, isNativeObjectType, isPrettyPrint, isSubtype, matchConstraint, matchRecordTypeConstraint, setImplicitPrototype, setOwnerFunction, setPrettyPrint, setPropertyNode, unboxesTo

Methods inherited from class com.google.javascript.rhino.jstype.ObjectType

cast, checkStructuralEquivalenceHelper, collectPropertyNames, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, detectImplicitPrototypeCycle, detectInheritanceCycle, findPropertyType, getDisplayName, getJSDocInfo, getNormalizedReferenceName, getOwnPropertyJSDocInfo, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyNames, getPropertyNode, getRootNode, getTemplateTypes, hasOwnDeclaredProperty, hasOwnProperty, hasProperty, isFunctionPrototypeType, isImplicitPrototype, isObject, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isStructuralSubtype, isStructuralType, isUnknownType, setJSDocInfo, testForEquality

Methods inherited from class com.google.javascript.rhino.jstype.JSType

autobox, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, checkEquivalenceHelper, checkEquivalenceHelper, collapseUnion, dereference, differsFrom, equals, extendTemplateTypeMap, filterNoResolvedType, getGreatestSubtype, getGreatestSubtype, getLeastSupertype, getLeastSupertype, getNativeType, getRestrictedTypeGivenToBooleanOutcome, getTemplateTypeMap, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, hasAnyTemplateTypes, hasDisplayName, isAllType, isArrayType, isBooleanObjectType, isBooleanValueType, isBottom, isCheckedUnknownType, isDateType, isDict, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, isExemptFromTemplateTypeInvariance, isExplicitlyVoidable, isFunctionType, isGlobalThisType, isNamedType, isNominalConstructor, isNominalType, isNoResolvedType, isNoType, isNullable, isNullType, isNumber, isNumberObjectType, isNumberValueType, isRecordType, isRegexpType, isResolved, isString, isStringObjectType, isStringValueType, isStruct, isSubtypeHelper, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTemplateType, isTemplatizedType, isTheObjectType, isUnionType, isVoidable, isVoidType, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, safeResolve, setResolvedTypeInternal, setValidator, testForEqualityHelper, toAnnotationString, toMaybeEnumElementType, toMaybeEnumType, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toMaybeRecordType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeUnionType, toNonNullAnnotationString, toObjectType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.javascript.rhino.TypeI

isBottom, isEquivalentTo, isFunctionType, isSubtypeOf, isUnknownType, restrictByNotNullOrUndefined, toMaybeObjectType

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

NoObjectType

NoObjectType(JSTypeRegistry registry)

Method Detail

isSubtype

public boolean isSubtype(JSType that)

Description copied from class: FunctionType

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.

Overrides:

isSubtype in class FunctionType

Returns:

this <: that

isSubtype

protected boolean isSubtype(JSType that,
                            JSType.ImplCache implicitImplCache)

Description copied from class: JSType

checking isSubtype with structural interface matching

Overrides:

isSubtype in class FunctionType

implicitImplCache - a cache that records the checked or currently checking type pairs, for example, if previous checking found that constructor C is a subtype of interface I, then in the cache, table key <I,C> maps to IMPLEMENT status.

toMaybeFunctionType

public FunctionType toMaybeFunctionType()

Description copied from class: JSType

Downcasts this to a FunctionType, or returns null if this is not a function. For the purposes of this function, we define a MaybeFunctionType as any type in the sub-lattice { x | LEAST_FUNCTION_TYPE <= x <= GREATEST_FUNCTION_TYPE } This definition excludes bottom types like NoType and NoObjectType. This definition is somewhat arbitrary and axiomatic, but this is the definition that makes the most sense for the most callers.

Specified by:

toMaybeFunctionType in interface TypeI

Overrides:

toMaybeFunctionType in class FunctionType

isNoObjectType

public boolean isNoObjectType()

Overrides:

isNoObjectType in class JSType

getImplicitPrototype

public ObjectType getImplicitPrototype()

Description copied from class: ObjectType

Gets the implicit prototype (a.k.a. the [[Prototype]] property).

Overrides:

getImplicitPrototype in class PrototypeObjectType

getReferenceName

public java.lang.String getReferenceName()

Description copied from class: ObjectType

Gets the reference name for this object. This includes named types like constructors, prototypes, and enums. It notably does not include literal types like strings and booleans and structural types.

Specified by:

getReferenceName in interface FunctionTypeI

Overrides:

getReferenceName in class PrototypeObjectType

Returns:

the object's name or null if this is an anonymous object

hasReferenceName

public boolean hasReferenceName()

Description copied from class: ObjectType

Returns true if the object is named.

Overrides:

hasReferenceName in class PrototypeObjectType

Returns:

true if the object is named, false if it is anonymous

matchesNumberContext

public boolean matchesNumberContext()

Description copied from class: JSType

This predicate is used to test whether a given type can appear in a numeric context, such as an operand of a multiply operator.

Overrides:

matchesNumberContext in class PrototypeObjectType

matchesObjectContext

public boolean matchesObjectContext()

Description copied from class: JSType

This predicate is used to test whether a given type can appear in an 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.

Overrides:

matchesObjectContext in class PrototypeObjectType

matchesStringContext

public boolean matchesStringContext()

Description copied from class: JSType

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. 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.

Overrides:

matchesStringContext in class PrototypeObjectType

hashCode

public int hashCode()

Overrides:

hashCode in class FunctionType

defineProperty

boolean defineProperty(java.lang.String propertyName,
                       JSType type,
                       boolean inferred,
                       Node propertyNode)

Description copied from class: ObjectType

Defines a property.

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).

Overrides:

defineProperty in class FunctionType

Parameters:

propertyName - the property's name

type - the type

inferred - true if this property's type is inferred

propertyNode - 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.

Returns:

True if the property was registered successfully, false if this conflicts with a previous property type declaration.

removeProperty

public boolean removeProperty(java.lang.String name)

Description copied from class: ObjectType

Removes the declared or inferred property from this ObjectType.

Overrides:

removeProperty in class PrototypeObjectType

Parameters:

name - the property's name

Returns:

true if the property was removed successfully. False if the property did not exist, or could not be removed.

setPropertyJSDocInfo

public void setPropertyJSDocInfo(java.lang.String propertyName,
                                 JSDocInfo info)

Description copied from class: ObjectType

Sets the docInfo for the specified property from the JSDocInfo on its definition.

Overrides:

setPropertyJSDocInfo in class PrototypeObjectType

info - JSDocInfo for the property definition. May be null.

visit

public <T> T visit(Visitor<T> visitor)

Description copied from class: JSType

Visit this type with the given visitor.

Overrides:

visit in class FunctionType

Returns:

the value returned by the visitor

See Also:

Visitor

visit

<T> T visit(RelationshipVisitor<T> visitor,
            JSType that)

Description copied from class: JSType

Visit the types with the given visitor.

Overrides:

visit in class FunctionType

Returns:

the value returned by the visitor

See Also:

RelationshipVisitor

toStringHelper

java.lang.String toStringHelper(boolean forAnnotations)

Description copied from class: FunctionType

Informally, a function is represented by function (params): returnType where the params is a comma separated list of types, the first one being a special this:T if the function expects a known type for this.

Overrides:

toStringHelper in class FunctionType

Parameters:

forAnnotations - Whether this is for use in code generator annotations. Otherwise, it's for warnings.

getConstructor

public FunctionType getConstructor()

Description copied from class: ObjectType

Gets this object's constructor.

Specified by:

getConstructor in interface ObjectTypeI

Overrides:

getConstructor in class PrototypeObjectType

Returns:

this object's constructor or null if it is a native object (constructed natively v.s. by instantiation of a function)

resolveInternal

JSType resolveInternal(ErrorReporter t,
                       StaticTypedScope<JSType> scope)

Overrides:

resolveInternal in class FunctionType

See Also:

JSType.resolve(com.google.javascript.rhino.ErrorReporter, com.google.javascript.rhino.jstype.StaticTypedScope<com.google.javascript.rhino.jstype.JSType>)