com.google.javascript.rhino

Interface ObjectTypeI

All Superinterfaces:

java.io.Serializable, TypeI

All Known Subinterfaces:

FunctionTypeI

All Known Implementing Classes:

EnumElementType, EnumType, FunctionType, NamedType, NoObjectType, NoResolvedType, NoType, ObjectType, PrototypeObjectType, ProxyObjectType, RecordType, TemplateType, TemplatizedType, UnknownType

public interface ObjectTypeI
extends TypeI

Author:

blickly@google.com (Ben Lickly), dimvar@google.com (Dimitris Vardoulakis)

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.javascript.rhino.TypeI

TypeI.Nullability, TypeI.TypeInference

Method Summary

Modifier and Type	Method and Description
FunctionTypeI	getConstructor() Gets this object's constructor, or null if it is a native object (constructed natively vs.
TypeI	getEnumeratedTypeOfEnumObject() If this type is an enum object, returns the declared type of the elements.
TypeI	getInstantiatedTypeArgument(TypeI supertype) Given an generic supertype of this, returns the type argument as instantiated by this type.
TypeI	getLegacyResolvedType() Only called on instances of NamedType.
FunctionTypeI	getOwnerFunction() If this type represents the object in a function's prototype property, return that function.
Node	getOwnPropertyDefSite(java.lang.String propertyName)
JSDocInfo	getOwnPropertyJSDocInfo(java.lang.String propertyName) TODO(dimvar): rename methods in this file that use the phrase OwnProp to NonInheritedProp, to avoid ambiguity with the built-in methods such as hasOwnProperty, which have different semantics.
java.lang.Iterable<java.lang.String>	getOwnPropertyNames() Return the names of all non-inherited properties of this type, including prototype properties.
Node	getPropertyDefSite(java.lang.String propertyName)
JSDocInfo	getPropertyJSDocInfo(java.lang.String propertyName)
java.util.Set<java.lang.String>	getPropertyNames() Returns a set of properties defined or inferred on this type or any of its supertypes.
TypeI	getPropertyType(java.lang.String propName) Returns the type of property propName on this object, or null if the property doesn't exist.
ObjectTypeI	getPrototypeObject() Returns the __proto__ object of this object type, NOT the ".prototype" property.
ObjectTypeI	getRawType() If this type is not generic, return as is.
FunctionTypeI	getSuperClassConstructor()
com.google.common.collect.ImmutableList<? extends TypeI>	getTemplateTypes() For an instantiated generic type, return the types that the type variables are mapped to.
ObjectTypeI	getTopDefiningInterface(java.lang.String propName) Given an interface and a property, finds a top-most super interface that has the property defined (including this interface).
boolean	hasOwnProperty(java.lang.String propertyName)
boolean	hasProperty(java.lang.String propertyName)
ObjectTypeI	instantiateGenericsWithUnknown() When this type represents an instance of a generic class/interface Foo, return an instance of Foo with type parameters mapped to the unknown type.
boolean	isAmbiguousObject() Returns true if this object is an anonymous object or function type (i.e.
boolean	isInstanceType() Whether this type is an instance object of some constructor.
boolean	isLegacyNamedType() The old type checker uses NamedType to wrap types (e.g., defined by typedefs), and to represent unresolved forward declares.
ObjectTypeI	normalizeObjectForCheckAccessControls() Works around the OTI distinction between prototype-object types and other objects.
ObjectTypeI	withoutStrayProperties() Remove any properties that exist only on this specific instance: stray properties, or properties whose type has been specialized.

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

autobox, autoboxAndGetObject, containsArray, getDisplayName, getEnumeratedTypeOfEnumElement, getGreatestSubtypeWithProperty, getJSDocInfo, getTypeParameters, getUnionMembers, isBooleanValueType, isBottom, isBoxableScalar, isConstructor, isEnumElement, isEnumObject, isEquivalentTo, isFullyInstantiated, isFunctionType, isGenericObjectType, isInstanceofObject, isInterface, isLiteralObject, isNullable, isNullType, isNumberValueType, isObjectType, isPartiallyInstantiated, isPrototypeObject, isRecordType, isSomeUnknownType, isStringValueType, isStructuralInterface, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTop, isTypeVariable, isUnionType, isUnknownType, isUnresolved, isUnresolvedOrResolvedUnknown, isVoidable, isVoidType, meetWith, restrictByNotNullOrUndefined, toAnnotationString, toMaybeFunctionType, toMaybeObjectType, typeInference

Method Detail

getConstructor

FunctionTypeI getConstructor()

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

getSuperClassConstructor

FunctionTypeI getSuperClassConstructor()

getPrototypeObject

ObjectTypeI getPrototypeObject()

Returns the __proto__ object of this object type, NOT the ".prototype" property.

getOwnPropertyJSDocInfo

JSDocInfo getOwnPropertyJSDocInfo(java.lang.String propertyName)

TODO(dimvar): rename methods in this file that use the phrase OwnProp to NonInheritedProp, to avoid ambiguity with the built-in methods such as hasOwnProperty, which have different semantics. The built-in methods also look at properties directly on the instance that have been copied from a super type, while we care only about non-inherited properties. The methods here have many uses, including in code outside the compiler codebase, which is why I'm deferring the renaming.

getPropertyJSDocInfo

JSDocInfo getPropertyJSDocInfo(java.lang.String propertyName)

getOwnPropertyDefSite

Node getOwnPropertyDefSite(java.lang.String propertyName)

getPropertyDefSite

Node getPropertyDefSite(java.lang.String propertyName)

isInstanceType

boolean isInstanceType()

Whether this type is an instance object of some constructor.

getRawType

ObjectTypeI getRawType()

If this type is not generic, return as is. If it is an instantiated generic type, drop the type arguments.

getTemplateTypes

com.google.common.collect.ImmutableList<? extends TypeI> getTemplateTypes()

For an instantiated generic type, return the types that the type variables are mapped to.

Returns:

Returns null if this type is not generic. TODO(dimvar): this could have a better name, but it's used by non-compiler code. Rename in a follow-up CL. TODO(dimvar): After deleting the old type checker, change the signature of this and other methods in TypeI to stop using wildcards.

instantiateGenericsWithUnknown

ObjectTypeI instantiateGenericsWithUnknown()

When this type represents an instance of a generic class/interface Foo, return an instance of Foo with type parameters mapped to the unknown type.

hasProperty

boolean hasProperty(java.lang.String propertyName)

hasOwnProperty

boolean hasOwnProperty(java.lang.String propertyName)

getOwnPropertyNames

java.lang.Iterable<java.lang.String> getOwnPropertyNames()

Return the names of all non-inherited properties of this type, including prototype properties. If this type represents an object literal, do not include Object.prototype properties.

normalizeObjectForCheckAccessControls

ObjectTypeI normalizeObjectForCheckAccessControls()

Works around the OTI distinction between prototype-object types and other objects. This method is a hack and can be deleted, either - when NTI treats objects in .prototype properties specially, or - when OTI is deleted. Currently, if Foo extends Bar, for the Bar instance pointed to by Foo.prototype, this method returns a Foo in OTI and a Bar in NTI.

isAmbiguousObject

boolean isAmbiguousObject()

Returns true if this object is an anonymous object or function type (i.e. the builtin Object or Function type, or a record or function literal). These types are ambiguous and should not participate in property renaming. Everything else has a named reference type and returns false.

isLegacyNamedType

boolean isLegacyNamedType()

The old type checker uses NamedType to wrap types (e.g., defined by typedefs), and to represent unresolved forward declares. NTI does not do that; unresolved types just become unknown. This method always returns false for NTI types.

getLegacyResolvedType

TypeI getLegacyResolvedType()

Only called on instances of NamedType. See also isLegacyNamedType.

getTopDefiningInterface

ObjectTypeI getTopDefiningInterface(java.lang.String propName)

Given an interface and a property, finds a top-most super interface that has the property defined (including this interface). If more than one interfaces have the property, the result is order-specific. Returns a type representing an instance of the interface, not the constructor.

getOwnerFunction

FunctionTypeI getOwnerFunction()

If this type represents the object in a function's prototype property, return that function.

getPropertyType

TypeI getPropertyType(java.lang.String propName)

Returns the type of property propName on this object, or null if the property doesn't exist.

getEnumeratedTypeOfEnumObject

TypeI getEnumeratedTypeOfEnumObject()

If this type is an enum object, returns the declared type of the elements. Otherwise returns null.

getInstantiatedTypeArgument

TypeI getInstantiatedTypeArgument(TypeI supertype)

Given an generic supertype of this, returns the type argument as instantiated by this type. Parameter supertype has to be a type with a single type parameter. For example,

   
   (Iterable<Foo>).getInstantiatedTypeArgument(Iterable<?>) returns Foo,
   and
   /** {@literal @}template A * /
   class Foo {}
   /**
    * {@literal @}template B
    * {@literal @}extends {Foo<Array<B>>}
    * /
   class Bar {}
   (Bar<string>).getInstantiatedTypeArguments(Bar<?>) returns string
   (Bar<string>).getInstantiatedTypeArguments(Foo<?>) returns Array<string>
 

This is used, for example, in type-checking for-of and yield.

getPropertyNames

java.util.Set<java.lang.String> getPropertyNames()

Returns a set of properties defined or inferred on this type or any of its supertypes.

withoutStrayProperties

ObjectTypeI withoutStrayProperties()

Remove any properties that exist only on this specific instance: stray properties, or properties whose type has been specialized. Keep all instance, prototype, and namespace properties.