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

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	declared
private boolean	isFrozen
private static long	serialVersionUID

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

ALPHA, registry, templateTypeMap

Constructor Summary

Constructors

Constructor and Description
RecordType(JSTypeRegistry registry, java.util.Map<java.lang.String,RecordTypeBuilder.RecordProperty> properties)
RecordType(JSTypeRegistry registry, java.util.Map<java.lang.String,RecordTypeBuilder.RecordProperty> properties, boolean declared) Creates a record type.

Method Summary

Modifier and Type	Method and Description
(package private) boolean	defineProperty(java.lang.String propertyName, JSType type, boolean inferred, Node propertyNode) Defines a property.
(package private) JSType	getGreatestSubtypeHelper(JSType that)
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, JSType.ImplCache implicitImplCache) checking isSubtype with structural interface matching
(package private) boolean	isSynthetic()
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, getPropertyMap, getReferenceName, hasCachedValues, hasReferenceName, isAnonymous, isNativeObjectType, isPrettyPrint, isSubtype, matchConstraint, matchesNumberContext, matchesObjectContext, matchesStringContext, matchRecordTypeConstraint, removeProperty, resolveInternal, setImplicitPrototype, setOwnerFunction, setPrettyPrint, setPropertyJSDocInfo, setPropertyNode, toStringHelper, unboxesTo

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

cast, checkStructuralEquivalenceHelper, clearCachedValues, collectPropertyNames, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, detectImplicitPrototypeCycle, detectInheritanceCycle, findPropertyType, getDisplayName, getJSDocInfo, getNormalizedReferenceName, getOwnPropertyJSDocInfo, getOwnPropertyNames, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyNames, getPropertyNode, getPropertyType, getPropertyTypeMap, getRootNode, getSlot, getTemplateTypes, getTypeOfThis, hasOwnDeclaredProperty, hasOwnProperty, hasProperty, isFunctionPrototypeType, isImplicitPrototype, isObject, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isStructuralSubtype, isUnknownType, setJSDocInfo, testForEquality, visit, visit

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

autobox, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, checkEquivalenceHelper, checkEquivalenceHelper, collapseUnion, dereference, differsFrom, equals, extendTemplateTypeMap, filterNoResolvedType, getGreatestSubtype, getGreatestSubtype, getLeastSupertype, getLeastSupertype, getNativeType, getRestrictedTypeGivenToBooleanOutcome, getTemplateTypeMap, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, hasAnyTemplateTypes, hasAnyTemplateTypesInternal, hasDisplayName, hashCode, isAllType, isArrayType, isBooleanObjectType, isBooleanValueType, isBottom, isCheckedUnknownType, isConstructor, isDateType, isDict, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, isExemptFromTemplateTypeInvariance, isExplicitlyVoidable, isFunctionType, isGlobalThisType, isInstanceType, isInterface, isNamedType, isNominalConstructor, isNominalType, isNoObjectType, isNoResolvedType, isNoType, isNullable, isNullType, isNumber, isNumberObjectType, isNumberValueType, isOrdinaryFunction, isRecordType, isRegexpType, isResolved, isString, isStringObjectType, isStringValueType, isStruct, isStructuralInterface, isSubtypeHelper, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTemplateType, isTemplatizedType, isTheObjectType, isUnionType, isVoidable, isVoidType, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, safeResolve, setResolvedTypeInternal, setValidator, testForEqualityHelper, toAnnotationString, toDebugHashCodeString, toMaybeEnumElementType, toMaybeEnumType, toMaybeFunctionType, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeUnionType, toNonNullAnnotationString, toObjectType, toString

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

declared

private final boolean declared

isFrozen

private boolean isFrozen

Constructor Detail

RecordType

RecordType(JSTypeRegistry registry,
           java.util.Map<java.lang.String,RecordTypeBuilder.RecordProperty> properties)

RecordType

RecordType(JSTypeRegistry registry,
           java.util.Map<java.lang.String,RecordTypeBuilder.RecordProperty> properties,
           boolean declared)

Creates a record type.

Parameters:

registry - The type registry under which this type lives.

properties - A map of all the properties of this record type.

declared - Whether this is a declared or synthesized type. A synthesized record type is just used for bookkeeping in the type system. A declared record type was actually used in the user's program.

Throws:

java.lang.IllegalStateException - if the RecordProperty associated with a property is null.

Method Detail

isSynthetic

boolean isSynthetic()

Returns:

Is this synthesized for internal bookkeeping?

getImplicitPrototype

public ObjectType getImplicitPrototype()

Description copied from class: ObjectType

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

Overrides:

getImplicitPrototype in class PrototypeObjectType

defineProperty

boolean defineProperty(java.lang.String propertyName,
                       JSType type,
                       boolean inferred,
                       Node propertyNode)

Description copied from class: ObjectType

Defines a property.

For clarity, callers should prefer ObjectType.defineDeclaredProperty(java.lang.String, com.google.javascript.rhino.jstype.JSType, com.google.javascript.rhino.Node) and ObjectType.defineInferredProperty(java.lang.String, com.google.javascript.rhino.jstype.JSType, com.google.javascript.rhino.Node).

Overrides:

defineProperty in class PrototypeObjectType

Parameters:

propertyName - the property's name

type - the type

inferred - true if this property's type is inferred

propertyNode - the node that represents the definition of property. Depending on the actual sub-type the node type might be different. The general idea is to have an estimate of where in the source code this property is defined.

Returns:

True if the property was registered successfully, false if this conflicts with a previous property type declaration.

getGreatestSubtypeHelper

JSType getGreatestSubtypeHelper(JSType that)

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

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.