com.google.javascript.rhino.jstype

Class RecordType

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

All Implemented Interfaces:

ObjectTypeI, TypeI, Serializable

public class RecordType
extends PrototypeObjectType

A record (structural) type. Subtyping: The subtyping of a record type is defined via structural comparison of a record type's properties. For example, a record type of the form { a : TYPE_1 } is a supertype of a record type of the form { b : TYPE_2, a : TYPE_1 } because B can be assigned to A and matches all constraints. Similarly, a defined type can be assigned to a record type so long as that defined type matches all property constraints of the record type. A record type of the form { a : A, b : B } can be assigned to a record of type { a : A }.

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
ObjectType	getImplicitPrototype() Gets the implicit prototype (a.k.a.
boolean	isStructuralType()
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
RecordType	toMaybeRecordType() Downcasts this to a RecordType, or returns null if this is not a RecordType.

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

canBeCalled, getConstructor, getCtorExtendedInterfaces, getCtorImplementedInterfaces, getOwnerFunction, getReferenceName, hasCachedValues, hashCode, hasReferenceName, isAnonymous, isNativeObjectType, matchConstraint, matchesNumberContext, matchesObjectContext, matchesStringContext, matchRecordTypeConstraint, removeProperty, setPropertyJSDocInfo, setPropertyNode, unboxesTo

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

cast, clearCachedValues, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, findPropertyType, getDisplayName, getEnumeratedTypeOfEnumObject, getJSDocInfo, getLegacyResolvedType, getNormalizedReferenceName, getOwnPropertyDefSite, getOwnPropertyJSDocInfo, getOwnPropertyNames, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyDefSite, getPropertyJSDocInfo, getPropertyNames, getPropertyNode, getPropertyType, getPropertyTypeMap, getPrototypeObject, getRawType, getRootNode, getSlot, getSuperClassConstructor, getTemplateTypes, getTopDefiningInterface, getTypeOfThis, hasOwnProperty, hasProperty, instantiateGenericsWithUnknown, isAmbiguousObject, isFunctionPrototypeType, isObject, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isUnknownType, normalizeObjectForCheckAccessControls, setJSDocInfo, testForEquality, visit

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

autobox, autoboxAndGetObject, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, collapseUnion, containsArray, dereference, differsFrom, equals, extendTemplateTypeMap, getEnumeratedTypeOfEnumElement, getGreatestSubtype, getGreatestSubtypeWithProperty, getLeastSupertype, getRestrictedTypeGivenToBooleanOutcome, getTemplateTypeMap, getTypeParameters, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, getUnionMembers, hasAnyTemplateTypes, hasDisplayName, isAllType, isArrayType, isBooleanObjectType, isBooleanValueType, isBottom, isBoxableScalar, isCheckedUnknownType, isConstructor, isDateType, isDict, isEmptyType, isEnumElement, isEnumElementType, isEnumObject, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, isExplicitlyVoidable, isFullyInstantiated, isFunctionType, isGenericObjectType, isGlobalThisType, isInstanceofObject, isInstanceType, isInterface, isLegacyNamedType, isLiteralObject, isNamedType, isNominalConstructor, isNominalType, isNoObjectType, isNoResolvedType, isNoType, isNullable, isNullType, isNumber, isNumberObjectType, isNumberValueType, isObjectType, isOrdinaryFunction, isPartiallyInstantiated, isPrototypeObject, isRecordType, isRegexpType, isResolved, isSomeUnknownType, isString, isStringObjectType, isStringValueType, isStruct, isStructuralInterface, isSubtype, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTemplateType, isTemplatizedType, isTop, isTypeVariable, isUnionType, isUnresolved, isUnresolvedOrResolvedUnknown, isVoidable, isVoidType, matchesInt32Context, matchesUint32Context, meetWith, resolve, restrictByNotNullOrUndefined, setValidator, toAnnotationString, toDebugHashCodeString, toMaybeEnumElementType, toMaybeEnumType, toMaybeFunctionType, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeUnionType, toObjectType, toString, typeInference

Methods inherited from class java.lang.Object

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

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

isInstanceType, isLegacyNamedType

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

autobox, autoboxAndGetObject, containsArray, getEnumeratedTypeOfEnumElement, getGreatestSubtypeWithProperty, 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, isUnresolved, isUnresolvedOrResolvedUnknown, isVoidable, isVoidType, meetWith, restrictByNotNullOrUndefined, toAnnotationString, toMaybeFunctionType, toMaybeObjectType, typeInference

Method Detail

getImplicitPrototype

public ObjectType getImplicitPrototype()

Description copied from class: ObjectType

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

Overrides:

getImplicitPrototype in class PrototypeObjectType

toMaybeRecordType

public RecordType toMaybeRecordType()

Description copied from class: JSType

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

Overrides:

toMaybeRecordType in class JSType

isStructuralType

public boolean isStructuralType()

Overrides:

isStructuralType in class ObjectType

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 PrototypeObjectType

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 PrototypeObjectType

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.