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

Show more of this group Show more artifacts with this name
Show all versions of closure-compiler-linter Show documentation

Closure Compiler is a JavaScript optimizing compiler. It parses your JavaScript, analyzes it, removes dead code and rewrites and minimizes what's left. It also checks syntax, variable references, and types, and warns about common JavaScript pitfalls. It is used in many of Google's JavaScript apps, including Gmail, Google Web Search, Google Maps, and Google Docs. This binary checks for style issues such as incorrect or missing JSDoc usage, and missing goog.require() statements. It does not do more advanced checks such as typechecking.

There is a newer version: v20200830

Show newest version

/*
 *
 * ***** 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 com.google.common.collect.ImmutableSortedMap;
import com.google.javascript.rhino.Node;
import java.util.HashMap;

/**
 * A builder for record types.
 *
 */
public class RecordTypeBuilder {
  private boolean isEmpty = true;
  private boolean isDeclared = true;
  private final JSTypeRegistry registry;
  private final HashMap properties = new HashMap<>();

  public RecordTypeBuilder(JSTypeRegistry registry) {
    this.registry = registry;
  }

  /** See the comments on RecordType about synthetic types. */
  void setSynthesized(boolean synthesized) {
    isDeclared = !synthesized;
  }

  /**
   * Adds a property with the given name and type to the record type.
   * If you add a property that has already been added, then {@link #build}
   * will fail.
   *
   * @param name the name of the new property
   * @param type the JSType of the new property
   * @param propertyNode the node that holds this property definition
   * @return The builder itself for chaining purposes.
   */
  public RecordTypeBuilder addProperty(String name, JSType type, Node propertyNode) {
    isEmpty = false;
    properties.put(name, new RecordProperty(type, propertyNode));
    return this;
  }

  /**
   * Creates a record. Fails if any duplicate property names were added.
   * @return The record type.
   */
  public JSType build() {
     // If we have an empty record, simply return the object type.
    if (isEmpty) {
       return registry.getNativeObjectType(JSTypeNative.OBJECT_TYPE);
    }
    ImmutableSortedMap.Builder m = ImmutableSortedMap.naturalOrder();
    m.putAll(this.properties);
    return new RecordType(registry, m.build(), isDeclared);
  }

  static class RecordProperty {
    private final JSType type;
    private final Node propertyNode;

    RecordProperty(JSType type, Node propertyNode) {
      this.type = type;
      this.propertyNode = propertyNode;
    }

    public JSType getType() {
      return type;
    }

    public Node getPropertyNode() {
      return propertyNode;
    }

    @Override
    public String toString() {
      return "RecordProperty{type: " + this.type + ", node: " + this.propertyNode + "}";
    }
  }
}