Module org.jgrapht.core

Package org.jgrapht.graph.builder

Class GraphBuilder<V,E,G extends Graph<V,E>>

java.lang.Object

org.jgrapht.graph.builder.AbstractGraphBuilder<V,E,G,GraphBuilder<V,E,G>>

org.jgrapht.graph.builder.GraphBuilder<V,E,G>

Type Parameters:

V - the graph vertex type

E - the graph edge type

G - type of the resulting graph

public class GraphBuilder<V,E,G extends Graph<V,E>>
extends AbstractGraphBuilder<V,E,G,GraphBuilder<V,E,G>>

A builder class for Graph. This is a helper class which helps adding vertices and edges into an already constructed graph instance.

Each graph implementation contains a static helper method for the construction of such a builder. For example class DefaultDirectedGraph contains method DefaultDirectedGraph.createBuilder(Supplier).

See GraphTypeBuilder for a builder of the actual graph instance.

Author:

Andrew Chen

See Also:

GraphTypeBuilder

Field Summary

Fields inherited from class org.jgrapht.graph.builder.AbstractGraphBuilder

graph

Constructor Summary

Constructors

Constructor	Description
GraphBuilder(G baseGraph)	Creates a builder based on baseGraph.

Method Summary

Modifier and Type	Method	Description
protected GraphBuilder<V,E,G>	self()

Methods inherited from class org.jgrapht.graph.builder.AbstractGraphBuilder

addEdge, addEdge, addEdge, addEdge, addEdgeChain, addGraph, addVertex, addVertices, build, buildAsUnmodifiable, removeEdge, removeEdge, removeVertex, removeVertices

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GraphBuilder

public GraphBuilder(G baseGraph)

Creates a builder based on baseGraph. baseGraph must be mutable.

The recommended way to use this constructor is: new GraphBuilderBase<...>(new YourGraph<...>(...)).

NOTE: baseGraph should not be an existing graph. If you want to add an existing graph to the graph being built, you should use the AbstractGraphBuilder.addVertex(Object) method.

Parameters:

baseGraph - the graph object to base building on

Method Detail

self

protected GraphBuilder<V,E,G> self()

Specified by:

self in class AbstractGraphBuilder<V,E,G extends Graph<V,E>,GraphBuilder<V,E,G extends Graph<V,E>>>

Returns:

the this object.