com.google.javascript.rhino.jstype

Class InstanceObjectType

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

All Implemented Interfaces:

ObjectTypeI, TypeI, java.io.Serializable

class InstanceObjectType
extends PrototypeObjectType

An object type that is an instance of some function constructor.

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 FunctionType	constructor
private static long	serialVersionUID

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

ALPHA, registry, templateTypeMap

Constructor Summary

Constructors

Constructor and Description
InstanceObjectType(JSTypeRegistry registry, FunctionType constructor)
InstanceObjectType(JSTypeRegistry registry, FunctionType constructor, boolean isNativeType)

Method Summary

Modifier and Type	Method and Description
(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.
java.lang.String	getReferenceName() Gets the reference name for this object.
int	hashCode() If this is equal to a NamedType object, its hashCode must be equal to the hashCode of the NamedType object.
boolean	hasReferenceName() Returns true if the object is named.
boolean	isArrayType()
boolean	isBooleanObjectType()
boolean	isDateType()
boolean	isInstanceType() Whether this type is an Instance object of some constructor.
boolean	isNominalType() Whether this type is a nominal type (a named instance object or a named enum).
boolean	isNumberObjectType()
boolean	isRegexpType()
boolean	isStringObjectType()
(package private) boolean	isTheObjectType()
(package private) java.lang.String	toStringHelper(boolean forAnnotations)

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

canBeCalled, getOwnerFunction, getPropertyMap, hasCachedValues, isAnonymous, isNativeObjectType, isPrettyPrint, isSubtype, isSubtype, isSubtype, matchConstraint, matchesNumberContext, matchesObjectContext, matchesStringContext, matchRecordTypeConstraint, removeProperty, resolveInternal, setImplicitPrototype, setOwnerFunction, setPrettyPrint, setPropertyJSDocInfo, setPropertyNode, unboxesTo

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, isAllType, isBooleanValueType, isBottom, isCheckedUnknownType, isConstructor, isDict, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, isExemptFromTemplateTypeInvariance, isExplicitlyVoidable, isFunctionType, isGlobalThisType, isInterface, isNamedType, isNominalConstructor, isNoObjectType, isNoResolvedType, isNoType, isNullable, isNullType, isNumber, isNumberValueType, isOrdinaryFunction, isRecordType, isResolved, isString, isStringValueType, isStruct, isStructuralInterface, isSubtypeHelper, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTemplateType, isTemplatizedType, 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

constructor

private final FunctionType constructor

Constructor Detail

InstanceObjectType

InstanceObjectType(JSTypeRegistry registry,
                   FunctionType constructor)

InstanceObjectType

InstanceObjectType(JSTypeRegistry registry,
                   FunctionType constructor,
                   boolean isNativeType)

Method Detail

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.

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

getImplicitPrototype

public ObjectType getImplicitPrototype()

Description copied from class: ObjectType

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

Overrides:

getImplicitPrototype in class PrototypeObjectType

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)

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

Overrides:

defineProperty in class PrototypeObjectType

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.

toStringHelper

java.lang.String toStringHelper(boolean forAnnotations)

Overrides:

toStringHelper in class PrototypeObjectType

Parameters:

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

isTheObjectType

boolean isTheObjectType()

Overrides:

isTheObjectType in class JSType

isInstanceType

public boolean isInstanceType()

Description copied from class: JSType

Whether this type is an Instance object of some constructor. Does not necessarily mean this is an InstanceObjectType.

Overrides:

isInstanceType in class JSType

isArrayType

public boolean isArrayType()

Overrides:

isArrayType in class JSType

isStringObjectType

public boolean isStringObjectType()

Overrides:

isStringObjectType in class JSType

isBooleanObjectType

public boolean isBooleanObjectType()

Overrides:

isBooleanObjectType in class JSType

isNumberObjectType

public boolean isNumberObjectType()

Overrides:

isNumberObjectType in class JSType

isDateType

public boolean isDateType()

Overrides:

isDateType in class JSType

isRegexpType

public boolean isRegexpType()

Overrides:

isRegexpType in class JSType

isNominalType

public boolean isNominalType()

Description copied from class: JSType

Whether this type is a nominal type (a named instance object or a named enum).

Overrides:

isNominalType in class JSType

hashCode

public int hashCode()

If this is equal to a NamedType object, its hashCode must be equal to the hashCode of the NamedType object.

Overrides:

hashCode in class JSType

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 PrototypeObjectType

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 PrototypeObjectType