Package com.google.javascript.rhino.jstype

Class EnumType

    • Method Detail

      • getSource

        public Node getSource()
        Gets the source node or null if this is an unknown enum.

      • toMaybeEnumType

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

      • getImplicitPrototype

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

      • getElements

        public java.util.Set<java.lang.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​(java.lang.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 &isin; 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 &lt;: that

      • getDisplayName

        public java.lang.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.

      • removeProperty

        public boolean removeProperty​(java.lang.String name)
        Description copied from class: ObjectType
        Removes the declared or inferred property from this ObjectType.
        Overrides:
        removeProperty in class ObjectType
        Parameters:
        name - the property's name
        Returns:
        true if the property was removed successfully. False if the property did not exist, or could not be removed.

      • setPropertyJSDocInfo

        public void setPropertyJSDocInfo​(java.lang.String propertyName,
                                 JSDocInfo info)
        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.

      • unboxesTo

        public JSType unboxesTo()
        Description copied from class: JSType
        Turn an object type to its corresponding scalar type.
        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 java.lang.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 values 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

      • getCtorImplementedInterfaces

        public java.lang.Iterable<ObjectType> getCtorImplementedInterfaces()
        Description copied from class: ObjectType
        Gets the interfaces implemented by the ctor associated with this type. Intended to be overridden by subclasses.
        Overrides:
        getCtorImplementedInterfaces in class ObjectType

      • getCtorExtendedInterfaces

        public java.lang.Iterable<ObjectType> getCtorExtendedInterfaces()
        Description copied from class: ObjectType
        Gets the interfaces extended by the interface associated with this type. Intended to be overridden by subclasses.
        Overrides:
        getCtorExtendedInterfaces in class ObjectType

      • matchConstraint

        public void matchConstraint​(JSType constraint)
        Description copied from class: JSType
        Modify this type so that it matches the specified type. This is useful for reverse type-inference, where we want to infer that an object literal matches its constraint (much like how the java compiler does reverse-inference to figure out generics).
        Overrides:
        matchConstraint in class JSType

      • matchRecordTypeConstraint

        public void matchRecordTypeConstraint​(ObjectType constraintObj)