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:

TypeWithProperties

public final class EnumType
extends Namespace
implements TypeWithProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	EnumType.State

Field Summary

Fields

Modifier and Type	Field and Description
private JSType	declaredType
private JSType	enumPropType
private com.google.common.collect.ImmutableSet<java.lang.String>	props
private EnumType.State	state
private JSTypeExpression	typeExpr

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

name, namespaceType, otherProps

Constructor Summary

Constructors

Modifier	Constructor and Description
private	EnumType(java.lang.String name, JSTypeExpression typeExpr, java.util.Collection<java.lang.String> props)

Method Summary

Modifier and Type	Method and Description
(package private) static boolean	areSubtypes(JSType t1, JSType t2, SubtypeCache subSuperMap)
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(java.lang.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
(package private) static boolean	hasNonScalar(com.google.common.collect.ImmutableSet<EnumType> enums)
boolean	hasProp(QualifiedName qname) Return whether this type contains a required property
(package private) static boolean	hasScalar(com.google.common.collect.ImmutableSet<EnumType> enums)
boolean	isResolved()
static EnumType	make(java.lang.String name, JSTypeExpression typeExpr, java.util.Collection<java.lang.String> props)
boolean	mayHaveProp(QualifiedName qname) Return whether this type contains any form of property
(package private) static com.google.common.collect.ImmutableSet<EnumType>	normalizeForJoin(com.google.common.collect.ImmutableSet<EnumType> newEnums, JSType joinWithoutEnums)
(package private) void	resolveEnum(JSType t)
java.lang.String	toString()
(package private) static com.google.common.collect.ImmutableSet<EnumType>	union(com.google.common.collect.ImmutableSet<EnumType> s1, com.google.common.collect.ImmutableSet<EnumType> s2)

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

addNamespace, addProperty, addTypedef, addUndeclaredProperty, copyWindowProperties, getAllPropsOfNamespace, getDeclaration, getName, getNsProp, getPropDeclaredType, getSubnamespace, hasProp, hasSubnamespace, isDefined, toJSType

Methods inherited from class java.lang.Object

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

Field Detail

state

private EnumType.State state

typeExpr

private JSTypeExpression typeExpr

declaredType

private JSType declaredType

enumPropType

private JSType enumPropType

props

private com.google.common.collect.ImmutableSet<java.lang.String> props

Constructor Detail

EnumType

private EnumType(java.lang.String name,
                 JSTypeExpression typeExpr,
                 java.util.Collection<java.lang.String> props)

Method Detail

make

public static EnumType make(java.lang.String name,
                            JSTypeExpression typeExpr,
                            java.util.Collection<java.lang.String> props)

isResolved

public boolean isResolved()

getEnumeratedType

public JSType getEnumeratedType()

getPropType

public JSType getPropType()

getTypeExpr

public JSTypeExpression getTypeExpr()

getTypeExprForErrorReporting

public JSTypeExpression getTypeExprForErrorReporting()

resolveEnum

void resolveEnum(JSType t)

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)

Description copied from interface: TypeWithProperties

Get the inferred type of the given property

Specified by:

getProp in interface TypeWithProperties

getDeclaredProp

public JSType getDeclaredProp(QualifiedName qname)

Description copied from interface: TypeWithProperties

Get the declared type of the given property

Specified by:

getDeclaredProp in interface TypeWithProperties

mayHaveProp

public boolean mayHaveProp(QualifiedName qname)

Description copied from interface: TypeWithProperties

Return whether this type contains any form of property

Specified by:

mayHaveProp in interface TypeWithProperties

hasProp

public boolean hasProp(QualifiedName qname)

Description copied from interface: TypeWithProperties

Return whether this type contains a required property

Specified by:

hasProp in interface TypeWithProperties

hasConstantProp

public boolean hasConstantProp(QualifiedName qname)

Description copied from interface: TypeWithProperties

Return whether this type contains a constant property

Specified by:

hasConstantProp in interface TypeWithProperties

enumLiteralHasKey

public boolean enumLiteralHasKey(java.lang.String name)

hasScalar

static boolean hasScalar(com.google.common.collect.ImmutableSet<EnumType> enums)

hasNonScalar

static boolean hasNonScalar(com.google.common.collect.ImmutableSet<EnumType> enums)

union

static com.google.common.collect.ImmutableSet<EnumType> union(com.google.common.collect.ImmutableSet<EnumType> s1,
                                                              com.google.common.collect.ImmutableSet<EnumType> s2)

normalizeForJoin

static com.google.common.collect.ImmutableSet<EnumType> normalizeForJoin(com.google.common.collect.ImmutableSet<EnumType> newEnums,
                                                                         JSType joinWithoutEnums)

areSubtypes

static boolean areSubtypes(JSType t1,
                           JSType t2,
                           SubtypeCache subSuperMap)

toString

public java.lang.String toString()

Overrides:

toString in class Namespace