com.google.javascript.jscomp.newtypes

Class EnumType

java.lang.Object

com.google.javascript.jscomp.newtypes.Namespace

com.google.javascript.jscomp.newtypes.EnumType

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.

Field Summary

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

duringComputeJSType, enums, name, namespaces, namespaceType, nominals, otherProps, scopes, typedefs

Method Summary

Modifier and Type	Method and Description
protected JSType	computeJSType(JSTypes commonTypes) 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
JSType	getEnumeratedType()
JSType	getProp(QualifiedName qname) Get the inferred type of the given property
JSType	getPropType()
JSTypeExpression	getTypeExpr()
JSTypeExpression	getTypeExprForErrorReporting()
boolean	hasConstantProp(QualifiedName qname) Return whether this type contains a constant property
boolean	hasProp(QualifiedName qname) Return whether this type contains a required property
boolean	isResolved()
static EnumType	make(String name, JSTypeExpression typeExpr, Collection<String> props)
boolean	mayHaveProp(QualifiedName qname) Return whether this type contains any form of property
String	toString()

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

addEnum, addNominalType, addProperty, addScope, addSubnamespace, addTypedef, addUndeclaredProperty, copyWindowProperties, getDeclaration, getName, getPropDeclaredType, getSubnamespace, hasProp, hasSubnamespace, isDefined, toJSType, withNamedTypes

Methods inherited from class java.lang.Object

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

Method Detail

make

public static EnumType make(String name,
                            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(JSTypes commonTypes)

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

getDeclaredProp

public JSType getDeclaredProp(QualifiedName qname)

Get the declared type of the given property

mayHaveProp

public boolean mayHaveProp(QualifiedName qname)

Return whether this type contains any form of property

hasProp

public boolean hasProp(QualifiedName qname)

Return whether this type contains a required property

hasConstantProp

public boolean hasConstantProp(QualifiedName qname)

Return whether this type contains a constant property

enumLiteralHasKey

public boolean enumLiteralHasKey(String name)

toString

public String toString()

Overrides:

toString in class Object