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, java.io.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.EqCache, JSType.ImplCache, JSType.MatchStatus, JSType.TypePair

Field Summary

Fields

Modifier and Type	Field and Description
(package private) TemplateTypeMapReplacer	replacer
private static long	serialVersionUID
(package private) com.google.common.collect.ImmutableList<JSType>	templateTypes

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

ALPHA, registry, templateTypeMap

Constructor Summary

Constructors

Constructor and Description
TemplatizedType(JSTypeRegistry registry, ObjectType objectType, com.google.common.collect.ImmutableList<JSType> templateTypes)

Method Summary

Modifier and Type	Method and Description
(package private) JSType	getGreatestSubtypeHelper(JSType rawThat) Computes the greatest subtype of two related templatized types.
JSType	getPropertyType(java.lang.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()
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
TemplatizedType	toMaybeTemplatizedType() Downcasts this to a TemplatizedType, or returns null if this is not a function.
(package private) java.lang.String	toStringHelper(boolean forAnnotations)
(package private) <T> T	visit(RelationshipVisitor<T> visitor, JSType that) Visit the types with the given visitor.
<T> T	visit(Visitor<T> visitor) Visit this type with the given visitor.
(package private) boolean	wrapsSameRawType(JSType that)

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

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

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

cast, checkStructuralEquivalenceHelper, clearCachedValues, collectPropertyNames, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, detectImplicitPrototypeCycle, detectInheritanceCycle, getCtorExtendedInterfaces, getDisplayName, getNormalizedReferenceName, getOwnPropertyJSDocInfo, getOwnPropertyNames, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyNames, getPropertyNode, getPropertyTypeMap, getRootNode, getSlot, hasCachedValues, hasOwnDeclaredProperty, hasOwnProperty, hasProperty, isFunctionPrototypeType, isImplicitPrototype, isObject, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isStructuralSubtype, setOwnerFunction, setPropertyNode

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

autobox, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, checkEquivalenceHelper, checkEquivalenceHelper, dereference, differsFrom, equals, extendTemplateTypeMap, filterNoResolvedType, getGreatestSubtype, getGreatestSubtype, getLeastSupertype, getLeastSupertype, getNativeType, getRestrictedTypeGivenToBooleanOutcome, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, hasAnyTemplateTypes, hasDisplayName, isArrayType, isBooleanObjectType, isBooleanValueType, isBottom, isDateType, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, isExemptFromTemplateTypeInvariance, isExplicitlyVoidable, isFunctionType, isGlobalThisType, isNamedType, isNominalConstructor, isNullType, isNumber, isNumberObjectType, isNumberValueType, isRecordType, isRegexpType, isResolved, isString, isStringObjectType, isStringValueType, isStructuralInterface, isSubtypeHelper, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTemplateType, isTemplatizedType, isTheObjectType, isUnionType, isVoidable, isVoidType, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, safeResolve, setResolvedTypeInternal, setValidator, testForEqualityHelper, toAnnotationString, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toNonNullAnnotationString, toObjectType, toString, unboxesTo

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, isEquivalentTo, isFunctionType, isSubtypeOf, restrictByNotNullOrUndefined, toMaybeObjectType

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

templateTypes

final com.google.common.collect.ImmutableList<JSType> templateTypes

replacer

final TemplateTypeMapReplacer replacer

Constructor Detail

TemplatizedType

TemplatizedType(JSTypeRegistry registry,
                ObjectType objectType,
                com.google.common.collect.ImmutableList<JSType> templateTypes)

Method Detail

toStringHelper

java.lang.String toStringHelper(boolean forAnnotations)

Overrides:

toStringHelper in class ProxyObjectType

Parameters:

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

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

visit

<T> T visit(RelationshipVisitor<T> visitor,
            JSType that)

Description copied from class: JSType

Visit the types with the given visitor.

Overrides:

visit in class ProxyObjectType

Returns:

the value returned by the visitor

See Also:

RelationshipVisitor

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.

Overrides:

getTemplateTypes in class ProxyObjectType

See Also:

TemplatizedType

getPropertyType

public JSType getPropertyType(java.lang.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.

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,
                            JSType.ImplCache implicitImplCache)

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.

wrapsSameRawType

boolean wrapsSameRawType(JSType that)

getGreatestSubtypeHelper

JSType getGreatestSubtypeHelper(JSType rawThat)

Computes the greatest subtype of two related templatized types.

Returns:

The greatest subtype.

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.