com.google.javascript.jscomp.graph.GraphvizGraph 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.List;

/**
 * A graph that can be dumped to a Graphviz DOT file.
 * 
 * An object which can be visualized as a graph should implement this interface.
 * The {@link com.google.javascript.jscomp.DotFormatter#toDot} function can be used to get a
 * visualization of the object for debugging purpose.
 *
 */
public interface GraphvizGraph {

  /**
   * Name of the graph.
   *
   * @return Name of the graph.
   */
  String getName();

  /**
   * Graph type.
   *
   * @return True if the graph is a directed graph.
   */
  boolean isDirected();

  /**
   * Retrieve a list of nodes in the graph.
   *
   * @return A list of nodes in the graph.
   */
  List getGraphvizNodes();

  /**
   * Retrieve a list of edges in the graph.
   *
   * @return A list of edges in the graph.
   */
  List getGraphvizEdges();


  /**
   * A Graphviz node.
   */
  interface GraphvizNode {

    /**
     * Retrieves the unique ID.
     *
     * @return A the unique ID of the node.
     */
    String getId();

    /**
     * Retrieves color of the node.
     *
     * @return The color of the node.
     */
    String getColor();

    /**
     * Retrieves the label of the node.
     *
     * @return Label of the node.
     */
    String getLabel();
  }


  /**
   * A Graphviz edge.
   */
  interface GraphvizEdge {

    /**
     * Get the first node in the edge. In a directed node, this will be the
     * source node.
     *
     * @return First node in the edge.
     */
    String getNode1Id();

    /**
     * Get the second node in the edge. In a directed node, this will be the
     * destination node.
     *
     * @return First node in the edge.
     */
    String getNode2Id();

    /**
     * Retrieves color of the edge.
     *
     * @return The color of the edge.
     */
    String getColor();

    /**
     * Retrieves the label of the edge.
     *
     * @return Label of the edge.
     */
    String getLabel();
  }
}