com.google.javascript.rhino.jstype

Class EnumType

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

All Implemented Interfaces:

ObjectTypeI, TypeI, Serializable

public class EnumType
extends PrototypeObjectType

An enum type representing a branded collection of elements. Each element is referenced by its name, and has an EnumElementType type.

See Also:

Serialized Form

Nested Class Summary

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

JSType.TypePair

Field Summary

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

templateTypeMap

Method Summary

Modifier and Type	Method and Description
boolean	defineElement(String name, Node definingNode) Defines a new element on this enum.
FunctionType	getConstructor() Gets this object's constructor.
String	getDisplayName() Returns a user meaningful label for the JSType instance.
Set<String>	getElements() Gets the elements defined on this enum.
EnumElementType	getElementsType() Gets the elements' type.
ObjectType	getImplicitPrototype() Gets the implicit prototype (a.k.a.
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) 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.
TernaryValue	testForEquality(JSType that) Compares this and that.
EnumType	toMaybeEnumType() Downcasts this to an EnumType, or returns null if this is not an EnumType.
<T> T	visit(Visitor<T> visitor) Visit this type with the given visitor.

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

canBeCalled, getCtorExtendedInterfaces, getCtorImplementedInterfaces, getOwnerFunction, getReferenceName, hasCachedValues, hasReferenceName, isAnonymous, isNativeObjectType, matchConstraint, matchRecordTypeConstraint, removeProperty, setPropertyJSDocInfo, setPropertyNode, unboxesTo

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

cast, clearCachedValues, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, findPropertyType, getJSDocInfo, getNormalizedReferenceName, getOwnPropertyJSDocInfo, getOwnPropertyNames, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyNames, getPropertyNode, getPropertyType, getPropertyTypeMap, getRootNode, getSlot, getTemplateTypes, getTypeOfThis, hasOwnProperty, hasProperty, isFunctionPrototypeType, isObject, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isStructuralType, isUnknownType, setJSDocInfo

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

autobox, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, collapseUnion, dereference, differsFrom, equals, extendTemplateTypeMap, getGreatestSubtype, getLeastSupertype, getRestrictedTypeGivenToBooleanOutcome, getTemplateTypeMap, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, hasAnyTemplateTypes, hasDisplayName, hashCode, isAllType, isArrayType, isBooleanObjectType, isBooleanValueType, isBottom, isCheckedUnknownType, isConstructor, isDateType, isDict, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, 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, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTemplateType, isTemplatizedType, isUnionType, isVoidable, isVoidType, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, setValidator, toAnnotationString, toDebugHashCodeString, toMaybeEnumElementType, toMaybeFunctionType, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toMaybeRecordType, 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

Method Detail

toMaybeEnumType

public EnumType toMaybeEnumType()

Description copied from class: JSType

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

Overrides:

toMaybeEnumType in class JSType

getImplicitPrototype

public ObjectType getImplicitPrototype()

Description copied from class: ObjectType

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

Overrides:

getImplicitPrototype in class PrototypeObjectType

getElements

public Set<String> getElements()

Gets the elements defined on this enum.

Returns:

the elements' names defined on this enum. The returned set is immutable.

defineElement

public boolean defineElement(String name,
                             Node definingNode)

Defines a new element on this enum.

Parameters:

name - the name of the new element

definingNode - the Node that defines this new element

Returns:

true iff the new element is added successfully

getElementsType

public EnumElementType getElementsType()

Gets the elements' type.

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

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)

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.

getDisplayName

public String getDisplayName()

Description copied from class: JSType

Returns a user meaningful label for the JSType instance. For example, Functions and Enums will return their declaration name (if they have one). Some types will not have a meaningful display name. Calls to hasDisplayName() will return true IFF getDisplayName() will return null or a zero length string.

Overrides:

getDisplayName in class ObjectType

Returns:

the display name of the type, or null if one is not available

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

getConstructor

public FunctionType getConstructor()

Description copied from class: ObjectType

Gets this object's constructor.

Specified by:

getConstructor in interface ObjectTypeI

Overrides:

getConstructor in class PrototypeObjectType

Returns:

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

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 PrototypeObjectType

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 PrototypeObjectType

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 PrototypeObjectType