InstanceObjectType (Compiler)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

All Implemented Interfaces:: Serializable

public final class InstanceObjectType
extends ObjectType
extends ObjectType

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

See Also:: Serialized Form

Nested Class Summary

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
`boolean`	`canBeCalled()` This predicate is used to test whether a given type can be used as the 'function' in a function call.
`FunctionType`	`getConstructor()` Gets this object's constructor.
`Iterable<ObjectType>`	`getCtorImplementedInterfaces()` Gets the interfaces implemented by the ctor associated with this type.
`ObjectType`	`getImplicitPrototype()` Gets the implicit prototype (a.k.a.
`JSDocInfo`	`getOwnPropertyJSDocInfo(String propertyName)` Gets the docInfo on the specified property on this type.
`Set<String>`	`getOwnPropertyNames()` Returns the names of all the properties directly 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.
`boolean`	`hasCachedValues()` Returns true if any cached valeus have been set for this type.
`int`	`hashCode()` If this is equal to a NamedType object, its hashCode must be equal to the hashCode of the NamedType object.
`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`	`isArrayType()`
`boolean`	`isBooleanObjectType()`
`boolean`	`isDateType()`
`boolean`	`isEquivalentTo(JSType that)` Checks if two types are equivalent.
`boolean`	`isInstanceType()` Whether this type is an Instance object of some constructor.
`boolean`	`isNativeObjectType()` Whether this is a built-in object.
`boolean`	`isNominalType()` Whether this type is a nominal type (a named instance object or a named enum).
`boolean`	`isNumberObjectType()`
`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 property)` Checks whether the property's type is inferred.
`boolean`	`isRegexpType()`
`boolean`	`isStringObjectType()`
`boolean`	`isSubtype(JSType that)` Checks whether `this` is a subtype of `that`.
`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`	`setPropertyJSDocInfo(String propertyName, JSDocInfo info, boolean inExterns)` Sets the docInfo for the specified property from the `JSDocInfo` on its definition.
`String`	`toString()`
`JSType`	`unboxesTo()` Gets the type to which this type unboxes.

Methods inherited from class com.google.javascript.rhino.jstype.ObjectType
`cast, clearCachedValues, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, findPropertyType, getDisplayName, getIndexType, getJSDocInfo, getNormalizedReferenceName, getParameterType, getPossibleToBooleanOutcomes, getPropertyNames, isObject, isUnknownType, setJSDocInfo, testForEquality, visit`

Methods inherited from class com.google.javascript.rhino.jstype.JSType
autoboxesTo, canAssignTo, canTestForEqualityWith, canTestForShallowEqualityWith, clearResolved, dereference, differsFrom, equals, forceResolve, getGreatestSubtype, getLeastSupertype, getRestrictedTypeGivenToBooleanOutcome, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, hasDisplayName, isAllType, isBooleanValueType, isCheckedUnknownType, isConstructor, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isFunctionPrototypeType, isFunctionType, isInterface, isNoObjectType, isNoResolvedType, isNoType, isNullable, isNullType, isNumber, isNumberValueType, isOrdinaryFunction, isRecordType, isResolved, isString, isStringValueType, isTemplateType, isUnionType, isVoidType, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, setValidator, toDebugHashCodeString, toObjectType

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

autoboxesTo, canAssignTo, canTestForEqualityWith, canTestForShallowEqualityWith, clearResolved, dereference, differsFrom, equals, forceResolve, getGreatestSubtype, getLeastSupertype, getRestrictedTypeGivenToBooleanOutcome, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, hasDisplayName, isAllType, isBooleanValueType, isCheckedUnknownType, isConstructor, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isFunctionPrototypeType, isFunctionType, isInterface, isNoObjectType, isNoResolvedType, isNoType, isNullable, isNullType, isNumber, isNumberValueType, isOrdinaryFunction, isRecordType, isResolved, isString, isStringValueType, isTemplateType, isUnionType, isVoidType, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, setValidator, toDebugHashCodeString, toObjectType

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Method Detail

getReferenceName

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

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.

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

getConstructor

public FunctionType getConstructor()

Description copied from class: ObjectType

Gets this object's constructor.

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

toString

public String toString()

isInstanceType

public boolean isInstanceType()

Description copied from class: JSType

Whether this type is an Instance object of some constructor.

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

isEquivalentTo

public boolean isEquivalentTo(JSType that)

Description copied from class: JSType

Checks if two types are equivalent.

Overrides:: isEquivalentTo 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 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

getPropertiesCount

public int getPropertiesCount()

Gets the number of properties of this object.

Specified by:: getPropertiesCount in class ObjectType

hasProperty

public boolean hasProperty(String propertyName)

Description copied from class: ObjectType

Checks whether the property whose name is given is present on the object.

Specified by:: hasProperty in class ObjectType

hasOwnProperty

public boolean hasOwnProperty(String propertyName)

Description copied from class: ObjectType

Checks whether the property whose name is given is present directly on the object. Returns false even if it is declared on a supertype.

Overrides:: hasOwnProperty in class ObjectType

getOwnPropertyNames

public Set<String> getOwnPropertyNames()

Description copied from class: ObjectType

Returns the names of all the properties directly on this type.

Overrides:: getOwnPropertyNames in class ObjectType

isPropertyTypeDeclared

public boolean isPropertyTypeDeclared(String property)

Description copied from class: ObjectType

Checks whether the property's type is declared.

Specified by:: isPropertyTypeDeclared in class ObjectType

isPropertyTypeInferred

public boolean isPropertyTypeInferred(String property)

Description copied from class: ObjectType

Checks whether the property's type is inferred.

Specified by:: isPropertyTypeInferred in class ObjectType

getPropertyType

public JSType getPropertyType(String propertyName)

Description copied from class: ObjectType

Gets the property type of the property whose name is given. If the underlying object does not have this property, the Unknown type is returned to indicate that no information is available on this property.

Specified by:: getPropertyType in class ObjectType

Returns:: the property's type or UnknownType. This method never returns null.

isPropertyInExterns

public boolean isPropertyInExterns(String propertyName)

Description copied from class: ObjectType

Checks whether the property was defined in the externs.

Overrides:: isPropertyInExterns in class ObjectType

getPropertyNode

public Node getPropertyNode(String propertyName)

Description copied from class: ObjectType

Gets the node corresponding to the definition of the specified property. This could be the node corresponding to declaration of the property or the node corresponding to the first reference to this property, e.g., "this.propertyName" in a constructor. Note this is mainly intended to be an estimate of where in the source code a property is defined. Sometime the returned node is not even part of the global AST but in the AST of the JsDoc that defines a type.

Overrides:: getPropertyNode in class ObjectType

Parameters:: propertyName - the name of the property
Returns:: the Node corresponding to the property or null.

getOwnPropertyJSDocInfo

public JSDocInfo getOwnPropertyJSDocInfo(String propertyName)

Description copied from class: ObjectType

Gets the docInfo on the specified property on this type. This should not be done implemented recursively, as you generally need to know exactly on which type in the prototype chain the JSDocInfo exists.

Overrides:: getOwnPropertyJSDocInfo in class ObjectType

setPropertyJSDocInfo

public void setPropertyJSDocInfo(String propertyName,
                                 JSDocInfo info,
                                 boolean inExterns)

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.

inExterns - true if this property was defined in an externs file. TightenTypes assumes that any function passed to an externs property could be called, so setting this incorrectly could result in live code being removed.

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

unboxesTo

public JSType unboxesTo()

Description copied from class: JSType

Gets the type to which this type unboxes.

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.

isSubtype

public boolean isSubtype(JSType that)

Description copied from class: JSType

Checks whether this is a subtype of that.

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.

Specified by:: isSubtype in class JSType

Returns:: this <: that

hasCachedValues

public boolean hasCachedValues()

Description copied from class: ObjectType

Returns true if any cached valeus 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

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.google.javascript.rhino.jstype Class InstanceObjectType

getReferenceName

hasReferenceName

getImplicitPrototype

getConstructor

toString

isInstanceType

isArrayType

isStringObjectType

isBooleanObjectType

isNumberObjectType

isDateType

isRegexpType

isNominalType

isEquivalentTo

hashCode

getCtorImplementedInterfaces

getPropertiesCount

hasProperty

hasOwnProperty

getOwnPropertyNames

isPropertyTypeDeclared

isPropertyTypeInferred

getPropertyType

isPropertyInExterns

getPropertyNode

getOwnPropertyJSDocInfo

setPropertyJSDocInfo

matchesNumberContext

matchesStringContext

unboxesTo

matchesObjectContext

canBeCalled

isSubtype

hasCachedValues

isNativeObjectType

com.google.javascript.rhino.jstype
Class InstanceObjectType