• Home
• com.google.javascript
• closure-compiler
• v20230502
• source code
• EnumType.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.javascript.rhino.jstype.EnumType Maven / Gradle / Ivy

/*
 *
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Rhino code, released
 * May 6, 1999.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1997-1999
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Bob Jervis
 *   Google Inc.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * the GNU General Public License Version 2 or later (the "GPL"), in which
 * case the provisions of the GPL are applicable instead of those above. If
 * you wish to allow use of your version of this file only under the terms of
 * the GPL and not to allow others to use your version of this file under the
 * MPL, indicate your decision by deleting the provisions above and replacing
 * them with the notice and other provisions required by the GPL. If you do
 * not delete the provisions above, a recipient may use your version of this
 * file under either the MPL or the GPL.
 *
 * ***** END LICENSE BLOCK ***** */

package com.google.javascript.rhino.jstype;

import static com.google.javascript.jscomp.base.Tri.FALSE;
import static com.google.javascript.jscomp.base.Tri.TRUE;

import com.google.javascript.jscomp.base.Tri;
import com.google.javascript.rhino.ErrorReporter;
import com.google.javascript.rhino.Node;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import org.jspecify.nullness.Nullable;

/**
 * An enum type representing a branded collection of elements. Each element is referenced by its
 * name, and has an {@link EnumElementType} type.
 *
 */
public final class EnumType extends PrototypeObjectType implements JSType.WithSourceRef {
  private static final JSTypeClass TYPE_CLASS = JSTypeClass.ENUM;

  // the type of the individual elements
  private EnumElementType elementType;
  // the elements' names (they all have the same type)
  private final Set elements = new HashSet<>();
  // the node representing rhs of the enum
  private final Node source;
  private final String googModuleId;

  public static Builder builder(JSTypeRegistry registry) {
    return new Builder(registry);
  }

  /** Builder */
  public static final class Builder extends PrototypeObjectType.Builder {

    private String elementName;
    private Node source;
    private String googModuleId;
    private JSType elementType;

    private Builder(JSTypeRegistry registry) {
      super(registry);
    }

    @Override
    public Builder setName(String x) {
      super.setName("enum{" + x + "}");
      this.elementName = x;
      return this;
    }

    /** The object literal that creates the enum, a reference to another enum, or null. */
    public Builder setSource(Node x) {
      this.source = x;
      return this;
    }

    /** The ID of the goog.module in which this enum was declared. */
    public Builder setGoogModuleId(String x) {
      this.googModuleId = x;
      return this;
    }

    /** The base type of the individual elements. */
    public Builder setElementType(JSType x) {
      this.elementType = x;
      return this;
    }

    @Override
    public EnumType build() {
      return new EnumType(this);
    }
  }

  private EnumType(Builder builder) {
    super(builder);
    this.elementType =
        new EnumElementType(builder.registry, builder.elementType, builder.elementName, this);
    this.source = builder.source;
    this.googModuleId = builder.googModuleId;

    registry.getResolver().resolveIfClosed(this, TYPE_CLASS);
  }

  @Override
  JSTypeClass getTypeClass() {
    return TYPE_CLASS;
  }

  @Override
  public EnumType toMaybeEnumType() {
    return this;
  }

  @Override
  public ObjectType getImplicitPrototype() {
    return registry.getNativeObjectType(JSTypeNative.OBJECT_TYPE);
  }

  /**
   * Gets the elements defined on this enum.
   * @return the elements' names defined on this enum. The returned set is
   *         immutable.
   */
  public Set getElements() {
    return Collections.unmodifiableSet(elements);
  }

  /**
   * Defines a new element on this enum.
   * @param name the name of the new element
   * @param definingNode the {@code Node} that defines this new element
   * @return true iff the new element is added successfully
   */
  public boolean defineElement(String name, Node definingNode) {
    elements.add(name);
    return defineDeclaredProperty(name, elementType, definingNode);
  }

  /** Gets the elements' type, which is a subtype of the enumerated type. */
  public EnumElementType getElementsType() {
    return elementType;
  }

  /** Gets the enumerated type. */
  @Override
  public JSType getEnumeratedTypeOfEnumObject() {
    return elementType.getPrimitiveType();
  }

  @Override
  public Tri testForEquality(JSType that) {
    Tri result = super.testForEquality(that);
    if (result != null) {
      return result;
    }
    return this.equals(that) ? TRUE : FALSE;
  }

  @Override
  void appendTo(TypeStringBuilder sb) {
    sb.append(sb.isForAnnotations() ? "!Object" : getReferenceName());
  }

  @Override
  public String getDisplayName() {
    return elementType.getDisplayName();
  }

  @Override
  public  T visit(Visitor visitor) {
    return visitor.caseObjectType(this);
  }

  @Override  T visit(RelationshipVisitor visitor, JSType that) {
    return visitor.caseObjectType(this, that);
  }

  @Override
  public @Nullable FunctionType getConstructor() {
    return null;
  }

  @Override
  public boolean matchesNumberContext() {
    return false;
  }

  @Override
  public boolean matchesStringContext() {
    return true;
  }

  @Override
  public boolean matchesObjectContext() {
    return true;
  }

  @Override
  public final Node getSource() {
    return source;
  }

  @Override
  public @Nullable String getGoogModuleId() {
    return this.googModuleId;
  }

  @Override
  JSType resolveInternal(ErrorReporter reporter) {
    elementType = (EnumElementType) elementType.resolve(reporter);
    return super.resolveInternal(reporter);
  }
}