com.google.javascript.jscomp.graph.GraphvizGraph Maven / Gradle / Ivy
/*
* 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 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();
}
}