com.google.javascript.rhino.jstype

Class TemplatizedType

java.lang.Object

com.google.javascript.rhino.jstype.JSType

com.google.javascript.rhino.jstype.ObjectType

com.google.javascript.rhino.jstype.ProxyObjectType

com.google.javascript.rhino.jstype.TemplatizedType

All Implemented Interfaces:

ObjectTypeI, TypeI, Serializable

public final class TemplatizedType
extends ProxyObjectType

An object type with declared template types, such as Array<string>.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.google.javascript.rhino.jstype.JSType

JSType.SubtypingMode, JSType.TypePair

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

TypeI.Nullability, TypeI.TypeInference

Field Summary

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

templateTypeMap

Method Summary

Modifier and Type	Method and Description
Iterable<ObjectType>	getCtorExtendedInterfaces() Gets the interfaces extended by the interface associated with this type.
Iterable<ObjectType>	getCtorImplementedInterfaces() Gets the interfaces implemented by the ctor associated with this type.
JSType	getPropertyType(String propertyName) Gets the property type of the property whose name is given.
ObjectType	getReferencedType()
TemplateTypeMap	getTemplateTypeMap() Returns the template type map associated with this type.
com.google.common.collect.ImmutableList<JSType>	getTemplateTypes() Gets the declared default element type.
boolean	hasAnyTemplateTypesInternal()
int	hashCode()
boolean	isSubtype(JSType that) Checks whether this is a subtype of that.
protected boolean	isSubtype(JSType that, com.google.javascript.rhino.jstype.JSType.ImplCache implicitImplCache, JSType.SubtypingMode subtypingMode) checking isSubtype with structural interface matching
TemplatizedType	toMaybeTemplatizedType() Downcasts this to a TemplatizedType, or returns null if this is not a function.
<T> T	visit(Visitor<T> visitor) Visit this type with the given visitor.

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

canBeCalled, collapseUnion, findPropertyType, getConstructor, getImplicitPrototype, getJSDocInfo, getOwnerFunction, getReferenceName, getTypeOfThis, hasReferenceName, isAllType, isCheckedUnknownType, isConstructor, isDict, isInstanceType, isInterface, isNativeObjectType, isNominalType, isNoObjectType, isNoResolvedType, isNoType, isNullable, isOrdinaryFunction, isStruct, isStructuralType, isUnknownType, isVoidable, matchConstraint, matchesNumberContext, matchesObjectContext, matchesStringContext, removeProperty, setJSDocInfo, setPropertyJSDocInfo, setValidator, testForEquality, toDebugHashCodeString, toMaybeEnumElementType, toMaybeEnumType, toMaybeFunctionType, toMaybeRecordType, toMaybeTemplateType, toMaybeUnionType, visitReferenceType

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

cast, clearCachedValues, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, getDisplayName, getEnumeratedTypeOfEnumObject, getLegacyResolvedType, getNormalizedReferenceName, getOwnPropertyDefSite, getOwnPropertyJSDocInfo, getOwnPropertyNames, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyDefSite, getPropertyJSDocInfo, getPropertyNames, getPropertyNode, getPropertyTypeMap, getPrototypeObject, getRawType, getRootNode, getSlot, getSuperClassConstructor, getTopDefiningInterface, hasCachedValues, hasOwnProperty, hasProperty, instantiateGenericsWithUnknown, isAmbiguousObject, isFunctionPrototypeType, isObject, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, normalizeObjectForCheckAccessControls, setPropertyNode

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

autobox, autoboxAndGetObject, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, containsArray, dereference, differsFrom, equals, extendTemplateTypeMap, getEnumeratedTypeOfEnumElement, getGreatestSubtype, getGreatestSubtypeWithProperty, getLeastSupertype, getRestrictedTypeGivenToBooleanOutcome, getTypeParameters, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, getUnionMembers, hasAnyTemplateTypes, hasDisplayName, isArrayType, isBooleanObjectType, isBooleanValueType, isBottom, isBoxableScalar, isDateType, isEmptyType, isEnumElement, isEnumElementType, isEnumObject, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, isExplicitlyVoidable, isFullyInstantiated, isFunctionType, isGenericObjectType, isGlobalThisType, isInstanceofObject, isLegacyNamedType, isLiteralObject, isNamedType, isNominalConstructor, isNullType, isNumber, isNumberObjectType, isNumberValueType, isObjectType, isPartiallyInstantiated, isPrototypeObject, isRecordType, isRegexpType, isResolved, isSomeUnknownType, isString, isStringObjectType, isStringValueType, isStructuralInterface, isSubtype, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTemplateType, isTemplatizedType, isTop, isTypeVariable, isUnionType, isUnresolved, isUnresolvedOrResolvedUnknown, isVoidType, matchesInt32Context, matchesUint32Context, meetWith, resolve, restrictByNotNullOrUndefined, toAnnotationString, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toObjectType, toString, typeInference, unboxesTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isLegacyNamedType

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

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

Method Detail

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 ProxyObjectType

getCtorExtendedInterfaces

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

hashCode

public int hashCode()

Overrides:

hashCode in class ProxyObjectType

visit

public <T> T visit(Visitor<T> visitor)

Description copied from class: JSType

Visit this type with the given visitor.

Overrides:

visit in class ProxyObjectType

Returns:

the value returned by the visitor

See Also:

Visitor

toMaybeTemplatizedType

public TemplatizedType toMaybeTemplatizedType()

Description copied from class: JSType

Downcasts this to a TemplatizedType, or returns null if this is not a function.

Overrides:

toMaybeTemplatizedType in class ProxyObjectType

getTemplateTypes

public com.google.common.collect.ImmutableList<JSType> getTemplateTypes()

Description copied from class: ObjectType

Gets the declared default element type.

Specified by:

getTemplateTypes in interface ObjectTypeI

Overrides:

getTemplateTypes in class ProxyObjectType

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.

See Also:

TemplatizedType

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. This gets overridden by FunctionType for lazily-resolved call() and bind() functions.

Specified by:

getPropertyType in interface ObjectTypeI

Overrides:

getPropertyType in class ObjectType

Returns:

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

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 ProxyObjectType

Returns:

this <: that

isSubtype

protected boolean isSubtype(JSType that,
                            com.google.javascript.rhino.jstype.JSType.ImplCache implicitImplCache,
                            JSType.SubtypingMode subtypingMode)

Description copied from class: JSType

checking isSubtype with structural interface matching

Overrides:

isSubtype in class ProxyObjectType

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.

getTemplateTypeMap

public TemplateTypeMap getTemplateTypeMap()

Description copied from class: JSType

Returns the template type map associated with this type.

Overrides:

getTemplateTypeMap in class ProxyObjectType

hasAnyTemplateTypesInternal

public boolean hasAnyTemplateTypesInternal()

Overrides:

hasAnyTemplateTypesInternal in class ProxyObjectType

getReferencedType

public ObjectType getReferencedType()

Returns:

The referenced ObjectType wrapped by this TemplatizedType.