com.google.javascript.jscomp.newtypes

Class EnumType

java.lang.Object

com.google.javascript.jscomp.newtypes.Namespace

com.google.javascript.jscomp.newtypes.EnumType

All Implemented Interfaces:

Serializable

public final class EnumType
extends Namespace

Author:

blickly@google.com (Ben Lickly), dimvar@google.com (Dimitris Vardoulakis) Represents an enumerated type. Each enum declaration produces two types of interest: - We represent the object literal that defined the enum as an ObjectType. - We represent an element of the enum by using this class in JSType.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.google.javascript.jscomp.newtypes.Namespace

commonTypes, defSite, name, namespaceType, otherProps

Method Summary

Modifier and Type	Method and Description
protected JSType	computeJSType() When defining an enum such as /** @enum {number} * / var X = { ONE: 1, TWO: 2 }; the properties of the object literal are constant.
boolean	enumLiteralHasKey(String name)
JSType	getDeclaredProp(QualifiedName qname) Get the declared type of the given property, or null if the named property is not declared.
JSType	getEnumeratedType()
JSType	getProp(QualifiedName qname) Get the inferred type of the given property.
JSType	getPropType()
Collection<JSType>	getSubtypesWithProperty(QualifiedName qname) Return all topmost subtypes of this type that have the given property.
JSTypeExpression	getTypeExpr()
JSTypeExpression	getTypeExprForErrorReporting()
boolean	hasConstantProp(QualifiedName qname) Return true if this type contains the given property and it is constant.
boolean	hasProp(QualifiedName qname) Return true if this type contains the given required property.
boolean	isResolved()
static EnumType	make(JSTypes commonTypes, String name, Node defSite, JSTypeExpression typeExpr, Collection<String> props)
boolean	mayHaveProp(QualifiedName qname) Return true if this type contains any form of the given property (this may include declared, inferred, required, or optional properties).

Methods inherited from class com.google.javascript.jscomp.newtypes.Namespace

addNamespace, addProperty, addTypedef, addUndeclaredProperty, copyWindowProperties, getDeclaration, getDefSite, getName, getPropDeclaredType, getSubnamespace, hasProp, hasSubnamespace, isDefined, toJSType, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

make

public static EnumType make(JSTypes commonTypes,
                            String name,
                            Node defSite,
                            JSTypeExpression typeExpr,
                            Collection<String> props)

isResolved

public boolean isResolved()

getEnumeratedType

public JSType getEnumeratedType()

getPropType

public JSType getPropType()

getTypeExpr

public JSTypeExpression getTypeExpr()

getTypeExprForErrorReporting

public JSTypeExpression getTypeExprForErrorReporting()

computeJSType

protected JSType computeJSType()

When defining an enum such as /** @enum {number} * / var X = { ONE: 1, TWO: 2 }; the properties of the object literal are constant.

Specified by:

computeJSType in class Namespace

getProp

public JSType getProp(QualifiedName qname)

Get the inferred type of the given property. Returns the undefined type if the named property is not found.

getDeclaredProp

public JSType getDeclaredProp(QualifiedName qname)

Get the declared type of the given property, or null if the named property is not declared.

mayHaveProp

public boolean mayHaveProp(QualifiedName qname)

Return true if this type contains any form of the given property (this may include declared, inferred, required, or optional properties).

hasProp

public boolean hasProp(QualifiedName qname)

Return true if this type contains the given required property. The qname must be an identifier, not a general qualified name.

hasConstantProp

public boolean hasConstantProp(QualifiedName qname)

Return true if this type contains the given property and it is constant. The qname must be an identifier, not a general qualified name.

enumLiteralHasKey

public boolean enumLiteralHasKey(String name)

getSubtypesWithProperty

public Collection<JSType> getSubtypesWithProperty(QualifiedName qname)

Return all topmost subtypes of this type that have the given property. If the type itself has the property then only this type is included in the result.