com.google.javascript.rhino.jstype

Class PrototypeObjectType

java.lang.Object

com.google.javascript.rhino.jstype.JSType

com.google.javascript.rhino.jstype.ObjectType

com.google.javascript.rhino.jstype.PrototypeObjectType

All Implemented Interfaces:

ObjectTypeI, TypeI, java.io.Serializable

Direct Known Subclasses:

EnumType, FunctionType, InstanceObjectType, RecordType

public class PrototypeObjectType
extends ObjectType

The object type represents instances of JavaScript objects such as Object, Date, Function.

Objects in JavaScript are unordered collections of properties. Each property consists of a name, a value and a set of attributes.

Each instance has an implicit prototype property ([[Prototype]]) pointing to an object instance, which itself has an implicit property, thus forming a chain.

A class begins life with no name. Later, a name may be provided once it can be inferred. Note that the name in this case is strictly for debugging purposes. Looking up type name references goes through the JSTypeRegistry.

See Also:

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 boolean	anonymousType
private java.lang.String	className
private ObjectType	implicitPrototypeFallback
private static int	MAX_PRETTY_PRINTED_PROPERTIES
private boolean	nativeType
private FunctionType	ownerFunction
private boolean	prettyPrint
private PropertyMap	properties
private static long	serialVersionUID

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

ALPHA, registry, templateTypeMap

Constructor Summary

Constructors

Constructor and Description
PrototypeObjectType(JSTypeRegistry registry, java.lang.String className, ObjectType implicitPrototype) Creates an object type.
PrototypeObjectType(JSTypeRegistry registry, java.lang.String className, ObjectType implicitPrototype, boolean anonymousType) Creates an object type.
PrototypeObjectType(JSTypeRegistry registry, java.lang.String className, ObjectType implicitPrototype, boolean nativeType, TemplateTypeMap templateTypeMap) Creates an object type, allowing specification of the implicit prototype, whether the object is native, and any templatized types.
PrototypeObjectType(JSTypeRegistry registry, java.lang.String className, ObjectType implicitPrototype, boolean nativeType, TemplateTypeMap templateTypeMap, boolean anonymousType) Creates an object type, allowing specification of the implicit prototype, whether the object is native, and any templatized types.

Method Summary

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.
(package private) boolean	defineProperty(java.lang.String name, JSType type, boolean inferred, Node propertyNode) Defines a property.
FunctionType	getConstructor() Gets this object's constructor.
java.lang.Iterable<ObjectType>	getCtorExtendedInterfaces() Gets the interfaces extended by the interface associated with this type.
java.lang.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.
(package private) PropertyMap	getPropertyMap() Returns the property map that manages the set of properties for an object.
java.lang.String	getReferenceName() Gets the reference name for this object.
boolean	hasCachedValues() Returns true if any cached values have been set for this type.
private boolean	hasOverridenNativeProperty(java.lang.String propertyName) Given the name of a native object property, checks whether the property is present on the object and different from the native one.
boolean	hasReferenceName() Returns true if the object is named.
private boolean	implicitPrototypeChainIsUnknown()
boolean	isAnonymous()
boolean	isNativeObjectType() Whether this is a built-in object.
(package private) boolean	isPrettyPrint()
boolean	isSubtype(JSType that) Checks whether this is a subtype of that.
protected boolean	isSubtype(JSType that, JSType.ImplCache implicitImplCache) checking isSubtype with structural interface matching
(package private) static boolean	isSubtype(ObjectType typeA, RecordType typeB, JSType.ImplCache implicitImplCache) Determines if typeA is a subtype of typeB
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(java.lang.String name) Removes the declared or inferred property from this ObjectType.
(package private) JSType	resolveInternal(ErrorReporter t, StaticTypedScope<JSType> scope)
(package private) void	setImplicitPrototype(ObjectType implicitPrototype) This should only be reset on the FunctionPrototypeType, only to fix an incorrectly established prototype chain due to the user having a mismatch in super class declaration, and only before properties on that type are processed.
(package private) void	setOwnerFunction(FunctionType type) Sets the owner function.
(package private) void	setPrettyPrint(boolean prettyPrint)
void	setPropertyJSDocInfo(java.lang.String propertyName, JSDocInfo info) Sets the docInfo for the specified property from the JSDocInfo on its definition.
void	setPropertyNode(java.lang.String propertyName, Node defSite) Sets the node where the property was defined.
(package private) java.lang.String	toStringHelper(boolean forAnnotations)
JSType	unboxesTo() Turn an object type to its corresponding scalar type.

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

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

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, hasAnyTemplateTypesInternal, hasDisplayName, hashCode, isAllType, isArrayType, isBooleanObjectType, isBooleanValueType, isBottom, isCheckedUnknownType, isConstructor, isDateType, isDict, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, isExemptFromTemplateTypeInvariance, isExplicitlyVoidable, isFunctionType, isGlobalThisType, isInstanceType, isInterface, isNamedType, isNominalConstructor, isNominalType, isNoObjectType, isNoResolvedType, isNoType, isNullable, isNullType, isNumber, isNumberObjectType, isNumberValueType, isOrdinaryFunction, isRecordType, isRegexpType, isResolved, isString, isStringObjectType, isStringValueType, isStruct, isStructuralInterface, isSubtypeHelper, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTemplateType, isTemplatizedType, isTheObjectType, isUnionType, isVoidable, isVoidType, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, safeResolve, setResolvedTypeInternal, setValidator, testForEqualityHelper, toAnnotationString, toDebugHashCodeString, toMaybeEnumElementType, toMaybeEnumType, toMaybeFunctionType, 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, isConstructor, isEquivalentTo, isFunctionType, isInterface, isSubtypeOf, restrictByNotNullOrUndefined, toMaybeFunctionType, toMaybeObjectType

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

className

private final java.lang.String className

properties

private final PropertyMap properties

nativeType

private final boolean nativeType

anonymousType

private final boolean anonymousType

implicitPrototypeFallback

private ObjectType implicitPrototypeFallback

ownerFunction

private FunctionType ownerFunction

prettyPrint

private boolean prettyPrint

MAX_PRETTY_PRINTED_PROPERTIES

private static final int MAX_PRETTY_PRINTED_PROPERTIES

See Also:

Constant Field Values

Constructor Detail

PrototypeObjectType

PrototypeObjectType(JSTypeRegistry registry,
                    java.lang.String className,
                    ObjectType implicitPrototype)

Creates an object type.

Parameters:

className - the name of the class. May be null to denote an anonymous class.

implicitPrototype - the implicit prototype (a.k.a. [[Prototype]]) as defined by ECMA-262. If the implicit prototype is null the implicit prototype will be set to the JSTypeNative.OBJECT_TYPE.

PrototypeObjectType

PrototypeObjectType(JSTypeRegistry registry,
                    java.lang.String className,
                    ObjectType implicitPrototype,
                    boolean anonymousType)

Creates an object type.

Parameters:

className - the name of the class. May be null to denote an anonymous class.

implicitPrototype - the implicit prototype (a.k.a. [[Prototype]]) as defined by ECMA-262. If the implicit prototype is null the implicit prototype will be set to the JSTypeNative.OBJECT_TYPE.

anonymousType - True if the class is intended to be anonymous.

PrototypeObjectType

PrototypeObjectType(JSTypeRegistry registry,
                    java.lang.String className,
                    ObjectType implicitPrototype,
                    boolean nativeType,
                    TemplateTypeMap templateTypeMap)

Creates an object type, allowing specification of the implicit prototype, whether the object is native, and any templatized types.

PrototypeObjectType

PrototypeObjectType(JSTypeRegistry registry,
                    java.lang.String className,
                    ObjectType implicitPrototype,
                    boolean nativeType,
                    TemplateTypeMap templateTypeMap,
                    boolean anonymousType)

Creates an object type, allowing specification of the implicit prototype, whether the object is native, and any templatized types.

Method Detail

getPropertyMap

PropertyMap getPropertyMap()

Description copied from class: ObjectType

Returns the property map that manages the set of properties for an object.

Overrides:

getPropertyMap in class ObjectType

defineProperty

boolean defineProperty(java.lang.String name,
                       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).

Specified by:

defineProperty in class ObjectType

Parameters:

name - 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 ObjectType

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 ObjectType

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

setPropertyNode

public void setPropertyNode(java.lang.String propertyName,
                            Node defSite)

Description copied from class: ObjectType

Sets the node where the property was defined.

Overrides:

setPropertyNode in class ObjectType

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 JSType

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 JSType

hasOverridenNativeProperty

private boolean hasOverridenNativeProperty(java.lang.String propertyName)

Given the name of a native object property, checks whether the property is present on the object and different from the native one.

unboxesTo

public JSType unboxesTo()

Description copied from class: JSType

Turn an object type to its corresponding scalar type.

Overrides:

unboxesTo in class JSType

Returns:

the unboxed type or null if this type does not unbox.

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 JSType

canBeCalled

public boolean canBeCalled()

Description copied from class: JSType

This predicate is used to test whether a given type can be used as the 'function' in a function call.

Overrides:

canBeCalled in class JSType

Returns:

true if this type might be callable.

toStringHelper

java.lang.String toStringHelper(boolean forAnnotations)

Specified by:

toStringHelper in class JSType

Parameters:

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

setPrettyPrint

void setPrettyPrint(boolean prettyPrint)

isPrettyPrint

boolean isPrettyPrint()

getConstructor

public FunctionType getConstructor()

Description copied from class: ObjectType

Gets this object's constructor.

Specified by:

getConstructor in interface ObjectTypeI

Specified by:

getConstructor in class ObjectType

Returns:

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

getImplicitPrototype

public ObjectType getImplicitPrototype()

Description copied from class: ObjectType

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

Specified by:

getImplicitPrototype in class ObjectType

setImplicitPrototype

final void setImplicitPrototype(ObjectType implicitPrototype)

This should only be reset on the FunctionPrototypeType, only to fix an incorrectly established prototype chain due to the user having a mismatch in super class declaration, and only before properties on that type are processed.

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 class ObjectType

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 ObjectType

Returns:

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

isAnonymous

public boolean isAnonymous()

isSubtype

public boolean isSubtype(JSType that)

Description copied from class: JSType

Checks whether this is a subtype of that.

Note this function also returns true if this type structurally matches the protocol define by that type (if that type is an interface function type) Subtyping rules:

• (unknown) — every type is a subtype of the Unknown type.
• (no) — the No type is a subtype of every type.
• (no-object) — the NoObject type is a subtype of every object type (i.e. subtypes of the Object type).
• (ref) — a type is a subtype of itself.
• (union-l) — A union type is a subtype of a type U if all the union type's constituents are a subtype of U. Formally
  (T1, …, Tn) <: U if and only Tk <: U for all k ∈ 1..n.
• (union-r) — A type U is a subtype of a union type if it is a subtype of one of the union type's constituents. Formally
  U <: (T1, …, Tn) if and only if U <: Tk for some index k.
• (objects) — an Object O1 is a subtype of an object O2 if it has more properties than O2 and all common properties are pairwise subtypes.

Overrides:

isSubtype in class JSType

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 JSType

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.

isSubtype

static boolean isSubtype(ObjectType typeA,
                         RecordType typeB,
                         JSType.ImplCache implicitImplCache)

Determines if typeA is a subtype of typeB

implicitPrototypeChainIsUnknown

private boolean implicitPrototypeChainIsUnknown()

hasCachedValues

public boolean hasCachedValues()

Description copied from class: ObjectType

Returns true if any cached values have been set for this type. If true, then the prototype chain should not be changed, as it might invalidate the cached values.

Overrides:

hasCachedValues in class ObjectType

isNativeObjectType

public boolean isNativeObjectType()

Whether this is a built-in object.

Overrides:

isNativeObjectType in class ObjectType

setOwnerFunction

void setOwnerFunction(FunctionType type)

Description copied from class: ObjectType

Sets the owner function. By default, does nothing.

Overrides:

setOwnerFunction in class ObjectType

getOwnerFunction

public FunctionType getOwnerFunction()

Description copied from class: ObjectType

Gets the owner of this if it's a function prototype.

Overrides:

getOwnerFunction in class ObjectType

getCtorImplementedInterfaces

public java.lang.Iterable<ObjectType> getCtorImplementedInterfaces()

Description copied from class: ObjectType

Gets the interfaces implemented by the ctor associated with this type. Intended to be overridden by subclasses.

Overrides:

getCtorImplementedInterfaces in class ObjectType

getCtorExtendedInterfaces

public java.lang.Iterable<ObjectType> getCtorExtendedInterfaces()

Description copied from class: ObjectType

Gets the interfaces extended by the interface associated with this type. Intended to be overridden by subclasses.

Overrides:

getCtorExtendedInterfaces in class ObjectType

resolveInternal

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

Specified by:

resolveInternal in class JSType

See Also:

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

matchConstraint

public void matchConstraint(JSType constraint)

Description copied from class: JSType

Modify this type so that it matches the specified type. This is useful for reverse type-inference, where we want to infer that an object literal matches its constraint (much like how the java compiler does reverse-inference to figure out generics).

Overrides:

matchConstraint in class JSType

matchRecordTypeConstraint

public void matchRecordTypeConstraint(ObjectType constraintObj)