Package com.google.javascript.rhino.jstype

Class EnumElementType

java.lang.Object
com.google.javascript.rhino.jstype.JSType
com.google.javascript.rhino.jstype.ObjectType
com.google.javascript.rhino.jstype.EnumElementType
public final class EnumElementType extends ObjectType
The type of individual elements of an enum type (see EnumType).

  • Method Details

    • getEnumType

      public EnumType getEnumType()

    • getPropertyKind

      public JSType.HasPropertyKind getPropertyKind(Property.Key propertyName, boolean autobox)
      Description copied from class: JSType
      Checks whether the property is present on the object.
      Overrides:
      getPropertyKind in class ObjectType
      Parameters:
      propertyName - The property name.
      autobox - Whether to check for the presents on an autoboxed type

    • getPropertyMap

      public com.google.javascript.rhino.jstype.PropertyMap getPropertyMap()

    • toMaybeEnumElementType

      public EnumElementType toMaybeEnumElementType()
      Description copied from class: JSType
      Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType.
      Overrides:
      toMaybeEnumElementType in class JSType

    • 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 JSType

    • 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 JSType

    • 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 JSType

    • matchesSymbolContext

      public boolean matchesSymbolContext()
      Description copied from class: JSType
      This predicate is used to test whether a given type can appear in a symbol context such as property access.
      Overrides:
      matchesSymbolContext in class JSType

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

    • isObject

      public boolean isObject()
      Description copied from class: JSType
      Tests whether this type is an Object, or any subtype thereof.
      Overrides:
      isObject in class ObjectType
      Returns:
      this <: Object

    • testForEquality

      public Tri testForEquality(JSType that)
      Description copied from class: JSType
      Compares this and that.
      Overrides:
      testForEquality in class ObjectType
      Returns:
      • Tri.TRUE if the comparison of values of this type and that always succeed (such as undefined compared to null)
      • Tri.FALSE if the comparison of values of this type and that always fails (such as undefined compared to number)
      • Tri.UNKNOWN if the comparison can succeed or fail depending on the concrete values

    • isNullable

      public boolean isNullable()
      Description copied from class: JSType
      Tests whether this type is nullable.
      Overrides:
      isNullable in class JSType

    • isVoidable

      public boolean isVoidable()
      Description copied from class: JSType
      Tests whether this type is voidable.
      Overrides:
      isVoidable in class JSType

    • isNominalType

      public boolean isNominalType()
      Description copied from class: JSType
      Whether this type is a nominal type (a named instance object or a named enum).
      Overrides:
      isNominalType in class JSType

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

      Returning an empty string means something different than returning null. An empty string may indicate an anonymous constructor, which we treat differently than a literal type without a reference name. e.g. in InstanceObjectType.appendTo(TypeStringBuilder)

      Specified by:
      getReferenceName in class ObjectType
      Returns:
      the object's name or null if this is an anonymous object

    • 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:

    • getImplicitPrototype

      public @Nullable ObjectType getImplicitPrototype()
      Description copied from class: ObjectType
      Gets the implicit prototype (a.k.a. the [[Prototype]] property).
      Specified by:
      getImplicitPrototype in class ObjectType

    • findPropertyTypeWithoutConsideringTemplateTypes

      protected JSType findPropertyTypeWithoutConsideringTemplateTypes(Property.Key propertyName)
      Description copied from class: JSType
      Looks up a property on this type, but without properly replacing any templates in the result.

      Subclasses can override this if they need more complicated logic for property lookup than just autoboxing to an object.

      This is only for use by findPropertyType(JSType). Call that method instead if you need to lookup a property on a random JSType

      Overrides:
      findPropertyTypeWithoutConsideringTemplateTypes in class ObjectType

    • getConstructor

      public @Nullable FunctionType getConstructor()
      Description copied from class: ObjectType
      Gets this object's constructor.
      Specified by:
      getConstructor in class ObjectType
      Returns:
      this object's constructor or null if it is a native object (constructed natively v.s. by instantiation of a function)

    • autoboxesTo

      public JSType autoboxesTo()
      Description copied from class: JSType
      Turn a scalar type to the corresponding object type.
      Overrides:
      autoboxesTo in class JSType
      Returns:
      the auto-boxed type or null if this type is not a scalar.

    • getPrimitiveType

      public JSType getPrimitiveType()
      Gets the primitive type of this enum element.