com.google.javascript.rhino.jstype

Class EnumElementType

java.lang.Object

com.google.javascript.rhino.jstype.JSType

com.google.javascript.rhino.jstype.ObjectType

com.google.javascript.rhino.jstype.EnumElementType

All Implemented Interfaces:

ObjectTypeI, TypeI, java.io.Serializable

public class EnumElementType
extends ObjectType

The type of individual elements of an enum type (see EnumType).

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 EnumType	enumType
private java.lang.String	name
private ObjectType	primitiveObjectType
private JSType	primitiveType The primitive type this enum element type wraps.
private static long	serialVersionUID

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

ALPHA, registry, templateTypeMap

Constructor Summary

Constructors

Constructor and Description
EnumElementType(JSTypeRegistry registry, JSType elementType, java.lang.String name, EnumType enumType)

Method Summary

Modifier and Type	Method and Description
JSType	autoboxesTo() Turn a scalar type to the corresponding object type.
boolean	canBeCalled() This predicate is used to test whether a given type can be used as the 'function' in a function call.
(package private) boolean	defineProperty(java.lang.String propertyName, JSType type, boolean inferred, Node propertyNode) Defines a property.
JSType	findPropertyType(java.lang.String propertyName) Coerces this type to an Object type, then gets the type of the property whose name is given.
FunctionType	getConstructor() Gets this object's constructor.
EnumType	getEnumType()
ObjectType	getImplicitPrototype() Gets the implicit prototype (a.k.a.
JSType	getPrimitiveType() Gets the primitive type of this enum element.
PropertyMap	getPropertyMap() Returns the property map that manages the set of properties for an object.
java.lang.String	getReferenceName() Gets the reference name for this object.
int	hashCode() If this is equal to a NamedType object, its hashCode must be equal to the hashCode of the NamedType object.
boolean	hasReferenceName() Returns true if the object is named.
boolean	isNominalType() Whether this type is a nominal type (a named instance object or a named enum).
boolean	isNullable() This predicate determines whether objects of this type can have the null value, and therefore can appear in contexts where null is expected.
boolean	isObject() Tests whether this type is an Object, or any subtype thereof.
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
boolean	matchesNumberContext() This predicate is used to test whether a given type can appear in a numeric context, such as an operand of a multiply operator.
boolean	matchesObjectContext() This predicate is used to test whether a given type can appear in an Object context, such as the expression in a with statement.
boolean	matchesStringContext() This predicate is used to test whether a given type can appear in a String context, such as an operand of a string concat (+) operator.
(package private) JSType	meet(JSType that) Returns the infimum of a enum element type and another type, or null if the infimum is empty.
(package private) JSType	resolveInternal(ErrorReporter t, StaticTypedScope<JSType> scope)
TernaryValue	testForEquality(JSType that) Compares this and that.
EnumElementType	toMaybeEnumElementType() Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType.
(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.

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

cast, checkStructuralEquivalenceHelper, clearCachedValues, collectPropertyNames, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, detectImplicitPrototypeCycle, detectInheritanceCycle, getCtorExtendedInterfaces, getCtorImplementedInterfaces, getDisplayName, getJSDocInfo, getNormalizedReferenceName, getOwnerFunction, getOwnPropertyJSDocInfo, getOwnPropertyNames, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyNames, getPropertyNode, getPropertyType, getPropertyTypeMap, getRootNode, getSlot, getTemplateTypes, getTypeOfThis, hasCachedValues, hasOwnDeclaredProperty, hasOwnProperty, hasProperty, isFunctionPrototypeType, isImplicitPrototype, isNativeObjectType, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isStructuralSubtype, isStructuralType, isUnknownType, removeProperty, setJSDocInfo, setOwnerFunction, setPropertyJSDocInfo, setPropertyNode

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

autobox, 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, isAllType, isArrayType, isBooleanObjectType, isBooleanValueType, isBottom, isCheckedUnknownType, isConstructor, isDateType, isDict, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, isExemptFromTemplateTypeInvariance, isExplicitlyVoidable, isFunctionType, isGlobalThisType, isInstanceType, isInterface, isNamedType, isNominalConstructor, isNoObjectType, isNoResolvedType, isNoType, isNullType, isNumber, isNumberObjectType, isNumberValueType, isOrdinaryFunction, isRecordType, isRegexpType, isResolved, isString, isStringObjectType, isStringValueType, isStruct, isStructuralInterface, isSubtypeHelper, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTemplateType, isTemplatizedType, isTheObjectType, isUnionType, isVoidable, isVoidType, matchConstraint, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, safeResolve, setResolvedTypeInternal, setValidator, testForEqualityHelper, toAnnotationString, toDebugHashCodeString, toMaybeEnumType, toMaybeFunctionType, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toMaybeRecordType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeUnionType, 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, isConstructor, isEquivalentTo, isFunctionType, isInterface, isSubtypeOf, restrictByNotNullOrUndefined, toMaybeFunctionType, toMaybeObjectType

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

primitiveType

private JSType primitiveType

The primitive type this enum element type wraps. For instance, in the following code defining the LOCAL_CODES enum

var LOCAL_CODES = {A: 3, B: 9, C: 8}

the primitive type of the the constants is number.

primitiveObjectType

private ObjectType primitiveObjectType

name

private final java.lang.String name

enumType

private final EnumType enumType

Constructor Detail

EnumElementType

EnumElementType(JSTypeRegistry registry,
                JSType elementType,
                java.lang.String name,
                EnumType enumType)

Method Detail

getEnumType

public EnumType getEnumType()

getPropertyMap

public PropertyMap getPropertyMap()

Description copied from class: ObjectType

Returns the property map that manages the set of properties for an object.

Overrides:

getPropertyMap in class ObjectType

toMaybeEnumElementType

public EnumElementType toMaybeEnumElementType()

Description copied from class: JSType

Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType.

Overrides:

toMaybeEnumElementType in class JSType

matchesNumberContext

public boolean matchesNumberContext()

Description copied from class: JSType

This predicate is used to test whether a given type can appear in a numeric context, such as an operand of a multiply operator.

Overrides:

matchesNumberContext in class JSType

matchesStringContext

public boolean matchesStringContext()

Description copied from class: JSType

This predicate is used to test whether a given type can appear in a String context, such as an operand of a string concat (+) operator. All types have at least the potential for converting to String. When we add externally defined types, such as a browser OM, we may choose to add types that do not automatically convert to String.

Overrides:

matchesStringContext in class JSType

matchesObjectContext

public boolean matchesObjectContext()

Description copied from class: JSType

This predicate is used to test whether a given type can appear in an Object context, such as the expression in a with statement. Most types we will encounter, except notably null, have at least the potential for converting to Object. Host defined objects can get peculiar.

Overrides:

matchesObjectContext in class JSType

canBeCalled

public boolean canBeCalled()

Description copied from class: JSType

This predicate is used to test whether a given type can be used as the 'function' in a function call.

Overrides:

canBeCalled in class JSType

Returns:

true if this type might be callable.

isObject

public boolean isObject()

Description copied from class: JSType

Tests whether this type is an Object, or any subtype thereof.

Overrides:

isObject in class ObjectType

Returns:

this <: Object

testForEquality

public TernaryValue testForEquality(JSType that)

Description copied from class: JSType

Compares this and that.

Overrides:

testForEquality in class ObjectType

Returns:

• TernaryValue.TRUE if the comparison of values of this type and that always succeed (such as undefined compared to null)
• TernaryValue.FALSE if the comparison of values of this type and that always fails (such as undefined compared to number)
• TernaryValue.UNKNOWN if the comparison can succeed or fail depending on the concrete values

isNullable

public boolean isNullable()

This predicate determines whether objects of this type can have the null value, and therefore can appear in contexts where null is expected.

Overrides:

isNullable in class JSType

Returns:

true for everything but Number and Boolean types.

isNominalType

public boolean isNominalType()

Description copied from class: JSType

Whether this type is a nominal type (a named instance object or a named enum).

Overrides:

isNominalType in class JSType

hashCode

public int hashCode()

If this is equal to a NamedType object, its hashCode must be equal to the hashCode of the NamedType object.

Overrides:

hashCode in class JSType

toStringHelper

java.lang.String toStringHelper(boolean forAnnotations)

Specified by:

toStringHelper in class JSType

Parameters:

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

getReferenceName

public java.lang.String getReferenceName()

Description copied from class: ObjectType

Gets the reference name for this object. This includes named types like constructors, prototypes, and enums. It notably does not include literal types like strings and booleans and structural types.

Specified by:

getReferenceName in class ObjectType

Returns:

the object's name or null if this is an anonymous object

hasReferenceName

public boolean hasReferenceName()

Description copied from class: ObjectType

Returns true if the object is named.

Overrides:

hasReferenceName in class ObjectType

Returns:

true if the object is named, false if it is anonymous

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 JSType

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 JSType

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.

visit

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

Description copied from class: JSType

Visit this type with the given visitor.

Overrides:

visit in class ObjectType

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 ObjectType

Returns:

the value returned by the visitor

See Also:

RelationshipVisitor

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

Specified by:

defineProperty in class ObjectType

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.

getImplicitPrototype

public ObjectType getImplicitPrototype()

Description copied from class: ObjectType

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

Specified by:

getImplicitPrototype in class ObjectType

findPropertyType

public JSType findPropertyType(java.lang.String propertyName)

Description copied from class: JSType

Coerces this type to an Object type, then gets the type of the property whose name is given. Unlike ObjectType.getPropertyType(java.lang.String), returns null if the property is not found.

Overrides:

findPropertyType in class ObjectType

Returns:

The property's type. null if the current type cannot have properties, or if the type is not found.

getConstructor

public FunctionType getConstructor()

Description copied from class: ObjectType

Gets this object's constructor.

Specified by:

getConstructor in interface ObjectTypeI

Specified by:

getConstructor in class ObjectType

Returns:

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

autoboxesTo

public JSType autoboxesTo()

Description copied from class: JSType

Turn a scalar type to the corresponding object type.

Overrides:

autoboxesTo in class JSType

Returns:

the auto-boxed type or null if this type is not a scalar.

getPrimitiveType

public JSType getPrimitiveType()

Gets the primitive type of this enum element.

meet

JSType meet(JSType that)

Returns the infimum of a enum element type and another type, or null if the infimum is empty. This can be a little bit weird. For example, suppose you have an enum of {(string|number)}, and you want the greatest subtype of the enum and a {number}. The infimum is non-empty. But at the same time, we don't really have a name for this infimum. It's equivalent to "elements of this enum that are numbers". The best we can do is make up a new type. This is similar to what we do in UnionType#meet, which kind-of-sort-of makes sense, because an EnumElementType is a union of instances of a type.

resolveInternal

JSType resolveInternal(ErrorReporter t,
                       StaticTypedScope<JSType> scope)

Specified by:

resolveInternal in class JSType

See Also:

JSType.resolve(com.google.javascript.rhino.ErrorReporter, com.google.javascript.rhino.jstype.StaticTypedScope<com.google.javascript.rhino.jstype.JSType>)