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

All Implemented Interfaces:

Serializable

public class EnumType
extends ObjectType

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

isEnumType

public boolean isEnumType()

Overrides:

isEnumType in class JSType

getImplicitPrototype

public ObjectType getImplicitPrototype()

Description copied from class: ObjectType

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

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.

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
  (T<sub>1</sub>, &hellip;, T<sub>n</sub>) &lt;: U if and only T<sub>k</sub> &lt;: 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 &lt;: (T<sub>1</sub>, &hellip;, T<sub>n</sub>) if and only if U &lt;: T<sub>k</sub> for some index k.
• (objects) — an Object O<sub>1</sub> is a subtype of an object O<sub>2</sub> if it has more properties than O<sub>2</sub> and all common properties are pairwise subtypes.

Returns:

this <: that

toString

public String toString()

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.

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.

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.

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.

getPropertiesCount

public int getPropertiesCount()

Gets the number of properties of this object.

Specified by:

getPropertiesCount in class ObjectType

hasProperty

public boolean hasProperty(String propertyName)

Description copied from class: ObjectType

Checks whether the property whose name is given is present on the object.

Specified by:

hasProperty in class ObjectType

hasOwnProperty

public boolean hasOwnProperty(String propertyName)

Description copied from class: ObjectType

Checks whether the property whose name is given is present directly on the object. Returns false even if it is declared on a supertype.

Overrides:

hasOwnProperty in class ObjectType

getOwnPropertyNames

public Set<String> getOwnPropertyNames()

Description copied from class: ObjectType

Returns the names of all the properties directly on this type.

Overrides:

getOwnPropertyNames in class ObjectType

isPropertyTypeDeclared

public boolean isPropertyTypeDeclared(String property)

Description copied from class: ObjectType

Checks whether the property's type is declared.

Specified by:

isPropertyTypeDeclared in class ObjectType

isPropertyTypeInferred

public boolean isPropertyTypeInferred(String property)

Description copied from class: ObjectType

Checks whether the property's type is inferred.

Specified by:

isPropertyTypeInferred in class ObjectType

getPropertyType

public JSType getPropertyType(String propertyName)

Description copied from class: ObjectType

Gets the property type of the property whose name is given. If the underlying object does not have this property, the Unknown type is returned to indicate that no information is available on this property.

Specified by:

getPropertyType in class ObjectType

Returns:

the property's type or UnknownType. This method never returns null.

isPropertyInExterns

public boolean isPropertyInExterns(String propertyName)

Description copied from class: ObjectType

Checks whether the property was defined in the externs.

Overrides:

isPropertyInExterns in class ObjectType

getPropertyNode

public Node getPropertyNode(String propertyName)

Description copied from class: ObjectType

Gets the node corresponding to the definition of the specified property. This could be the node corresponding to declaration of the property or the node corresponding to the first reference to this property, e.g., "this.propertyName" in a constructor. Note this is mainly intended to be an estimate of where in the source code a property is defined. Sometime the returned node is not even part of the global AST but in the AST of the JsDoc that defines a type.

Overrides:

getPropertyNode in class ObjectType

Parameters:

propertyName - the name of the property

Returns:

the Node corresponding to the property or null.

getOwnPropertyJSDocInfo

public JSDocInfo getOwnPropertyJSDocInfo(String propertyName)

Description copied from class: ObjectType

Gets the docInfo on the specified property on this type. This should not be done implemented recursively, as you generally need to know exactly on which type in the prototype chain the JSDocInfo exists.

Overrides:

getOwnPropertyJSDocInfo in class ObjectType

setPropertyJSDocInfo

public void setPropertyJSDocInfo(String propertyName,
                                 JSDocInfo info,
                                 boolean inExterns)

Description copied from class: ObjectType

Sets the docInfo for the specified property from the JSDocInfo on its definition.

Overrides:

setPropertyJSDocInfo in class ObjectType

info - JSDocInfo for the property definition. May be null.

inExterns - true if this property was defined in an externs file. TightenTypes assumes that any function passed to an externs property could be called, so setting this incorrectly could result in live code being removed.

unboxesTo

public JSType unboxesTo()

Description copied from class: JSType

Gets the type to which this type unboxes.

Overrides:

unboxesTo in class JSType

Returns:

the unboxed type or null if this type does not unbox.

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.

getReferenceName

public 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

hasCachedValues

public boolean hasCachedValues()

Description copied from class: ObjectType

Returns true if any cached valeus have been set for this type. If true, then the prototype chain should not be changed, as it might invalidate the cached values.

Overrides:

hasCachedValues in class ObjectType

isNativeObjectType

public boolean isNativeObjectType()

Whether this is a built-in object.

Overrides:

isNativeObjectType in class ObjectType

© 2009 Google - Privacy Policy - Terms and Conditions - About Google