com.google.javascript.jscomp.colors.ObjectColor 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

/*
 * Copyright 2020 The Closure Compiler Authors.
 *
 * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.javascript.jscomp.colors;

import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableList;
import javax.annotation.Nullable;

/**
 * A user-defined object type. For now each type is defined by a unique class name and file source.
 */
@AutoValue
public abstract class ObjectColor implements Color {

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

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

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

  @Override
  public ImmutableCollection getAlternates() {
    throw new UnsupportedOperationException();
  }

  public abstract String getClassName();

  public abstract String getFilename();

  // given `function Foo() {}` or `class Foo {}`, color of Foo.prototype. null otherwise.
  @Nullable
  public abstract Color getPrototype();

  @Nullable
  public abstract Color getInstanceColor();

  // List of other colors directly above this in the subtyping graph for the purposes of property
  // (dis)ambiguation.
  public abstract ImmutableList getDisambiguationSupertypes();

  @Override
  public abstract boolean isInvalidating();

  /** Builder for ObjectColors */
  @AutoValue.Builder
  public abstract static class Builder {
    public abstract Builder setClassName(String value);

    public abstract Builder setFilename(String value);

    public abstract Builder setInvalidating(boolean value);

    public abstract Builder setDisambiguationSupertypes(ImmutableList supertypes);

    public abstract Builder setPrototype(Color prototype);

    public abstract Builder setInstanceColor(Color instanceColor);

    public abstract ObjectColor build();
  }

  public static Builder builder() {
    return new AutoValue_ObjectColor.Builder()
        .setInvalidating(false)
        .setDisambiguationSupertypes(ImmutableList.of());
  }
}