public class PrototypeObjectType extends ObjectType
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
.
JSType.EqCache, JSType.ImplCache, JSType.MatchStatus, JSType.TypePair
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 |
ALPHA, registry, templateTypeMap
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.
|
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.
|
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
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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
isBottom, isConstructor, isEquivalentTo, isFunctionType, isInterface, isSubtypeOf, restrictByNotNullOrUndefined, toMaybeFunctionType, toMaybeObjectType
private static final long serialVersionUID
private final java.lang.String className
private final PropertyMap properties
private final boolean nativeType
private final boolean anonymousType
private ObjectType implicitPrototypeFallback
private FunctionType ownerFunction
private boolean prettyPrint
private static final int MAX_PRETTY_PRINTED_PROPERTIES
PrototypeObjectType(JSTypeRegistry registry, java.lang.String className, ObjectType implicitPrototype)
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(JSTypeRegistry registry, java.lang.String className, ObjectType implicitPrototype, boolean anonymousType)
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(JSTypeRegistry registry, java.lang.String className, ObjectType implicitPrototype, boolean nativeType, TemplateTypeMap templateTypeMap)
PrototypeObjectType(JSTypeRegistry registry, java.lang.String className, ObjectType implicitPrototype, boolean nativeType, TemplateTypeMap templateTypeMap, boolean anonymousType)
PropertyMap getPropertyMap()
ObjectType
getPropertyMap
in class ObjectType
boolean defineProperty(java.lang.String name, JSType type, boolean inferred, Node propertyNode)
ObjectType
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)
.
defineProperty
in class ObjectType
name
- the property's nametype
- the typeinferred
- true
if this property's type is inferredpropertyNode
- 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.public boolean removeProperty(java.lang.String name)
ObjectType
removeProperty
in class ObjectType
name
- the property's namepublic void setPropertyJSDocInfo(java.lang.String propertyName, JSDocInfo info)
ObjectType
JSDocInfo
on its definition.setPropertyJSDocInfo
in class ObjectType
info
- JSDocInfo
for the property definition. May be
null
.public void setPropertyNode(java.lang.String propertyName, Node defSite)
ObjectType
setPropertyNode
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
private boolean hasOverridenNativeProperty(java.lang.String propertyName)
public JSType unboxesTo()
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.java.lang.String toStringHelper(boolean forAnnotations)
toStringHelper
in class JSType
forAnnotations
- Whether this is for use in code generator
annotations. Otherwise, it's for warnings.void setPrettyPrint(boolean prettyPrint)
boolean isPrettyPrint()
public FunctionType getConstructor()
ObjectType
getConstructor
in interface ObjectTypeI
getConstructor
in class ObjectType
null
if it is a native
object (constructed natively v.s. by instantiation of a function)public ObjectType getImplicitPrototype()
ObjectType
[[Prototype]]
property).getImplicitPrototype
in class ObjectType
final void setImplicitPrototype(ObjectType implicitPrototype)
public java.lang.String getReferenceName()
ObjectType
getReferenceName
in class ObjectType
null
if this is an anonymous
objectpublic boolean hasReferenceName()
ObjectType
hasReferenceName
in class ObjectType
public boolean isAnonymous()
public boolean isSubtype(JSType that)
JSType
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:
(T1, …, Tn) <: U
if and only
Tk <: U
for all k ∈ 1..n
.U <: (T1, …, Tn)
if and only
if U <: Tk
for some index k
.O1
is a subtype
of an object O2
if it has more properties
than O2
and all common properties are
pairwise subtypes.protected boolean isSubtype(JSType that, JSType.ImplCache implicitImplCache)
JSType
static boolean isSubtype(ObjectType typeA, RecordType typeB, JSType.ImplCache implicitImplCache)
private boolean implicitPrototypeChainIsUnknown()
public boolean hasCachedValues()
ObjectType
hasCachedValues
in class ObjectType
public boolean isNativeObjectType()
isNativeObjectType
in class ObjectType
void setOwnerFunction(FunctionType type)
ObjectType
setOwnerFunction
in class ObjectType
public FunctionType getOwnerFunction()
ObjectType
getOwnerFunction
in class ObjectType
public java.lang.Iterable<ObjectType> getCtorImplementedInterfaces()
ObjectType
getCtorImplementedInterfaces
in class ObjectType
public java.lang.Iterable<ObjectType> getCtorExtendedInterfaces()
ObjectType
getCtorExtendedInterfaces
in class ObjectType
JSType resolveInternal(ErrorReporter t, StaticTypedScope<JSType> scope)
public void matchConstraint(JSType constraint)
JSType
matchConstraint
in class JSType
public void matchRecordTypeConstraint(ObjectType constraintObj)