com.google.javascript.jscomp.graph.AdjacencyGraph Maven / Gradle / Ivy

Go to download

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

/*
 * Copyright 2008 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.graph;

import java.util.Collection;

/**
 * A minimal graph interface.  Provided is add nodes to the graph, adjacency
 * calculation between a SubGraph and a GraphNode, and adding node annotations.
 *
 * For a more extensive interface, see {@link Graph}.
 *
 *
 * @param  Value type that the graph node stores.
 * @param  Value type that the graph edge stores.
 * @see Graph
 */
public interface AdjacencyGraph {
  /** Gets an immutable list of all nodes. */
  Collection> getNodes();

  int getNodeCount();

  /**
   * Gets a node from the graph given a value. Values equality are compared
   * using Object.equals.
   *
   * @param value The node's value.
   * @return The corresponding node in the graph, null if there value has no
   *         corresponding node.
   */
  GraphNode getNode(N value);

  /** Returns an empty SubGraph for this Graph. */
  SubGraph newSubGraph();

  /** Makes each node's annotation null. */
  void clearNodeAnnotations();

  /**
   * Returns a weight for the given value to be used in ordering nodes, e.g.
   * in {@link GraphColoring}.
   */
  int getWeight(N value);
}