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

Show more of this group Show more artifacts with this name
Show all versions of closure-compiler 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.

There is a newer version: v20240317

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.ImmutableList;
import org.jspecify.nullness.Nullable;

/**
 * An unresolved type that was forward declared. So we know it exists,
 * but that it wasn't pulled into this binary.
 *
 * In most cases, it behaves like a bottom type in the type lattice:
 * no real type should be assigned to a NoResolvedType, but the
 * NoResolvedType is a subtype of everything. In a few cases, it behaves
 * like the unknown type: properties of this type are also NoResolved types,
 * and comparisons to other types always have an unknown result.
 *
 * @author [email protected] (Nick Santos)
 */
public final class NoResolvedType extends NoType {
  /** The name originally used to reference this type, or {@code null} if none. */
  private @Nullable String referenceName;
  /**
   * Any template arguments to this type, or {@code null} if none. This field is not used for
   * JSCompiler's type checking; it is only needed by Clutz.
   */
  private @Nullable ImmutableList templateTypes;

  NoResolvedType(JSTypeRegistry registry) {
    super(registry);
  }

  NoResolvedType(
      JSTypeRegistry registry, String referenceName, ImmutableList templateTypes) {
    this(registry);
    this.referenceName = referenceName;
    this.templateTypes = templateTypes;
  }

  @Override
  JSTypeClass getTypeClass() {
    return JSTypeClass.NO_RESOLVED;
  }

  @Override
  public @Nullable String getReferenceName() {
    return referenceName;
  }

  @Override
  public @Nullable ImmutableList getTemplateTypes() {
    return templateTypes;
  }

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

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

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