org.jgrapht.graph.builder.GraphBuilder Maven / Gradle / Ivy
/*
* (C) Copyright 2015-2023, by Andrew Chen and Contributors.
*
* JGraphT : a free Java graph-theory library
*
* See the CONTRIBUTORS.md file distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the
* GNU Lesser General Public License v2.1 or later
* which is available at
* http://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html.
*
* SPDX-License-Identifier: EPL-2.0 OR LGPL-2.1-or-later
*/
package org.jgrapht.graph.builder;
import org.jgrapht.*;
import org.jgrapht.graph.*;
import java.util.function.*;
/**
* A builder class for {@link 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 {@link DefaultDirectedGraph} contains method
* {@link DefaultDirectedGraph#createBuilder(Supplier)}.
*
*
* See {@link GraphTypeBuilder} for a builder of the actual graph instance.
*
* @param the graph vertex type
* @param the graph edge type
* @param type of the resulting graph
*
* @author Andrew Chen
* @see GraphTypeBuilder
*/
public class GraphBuilder>
extends AbstractGraphBuilder>
{
/**
* Creates a builder based on {@code baseGraph}. {@code baseGraph} must be mutable.
*
*
* The recommended way to use this constructor is: {@code new
* GraphBuilderBase<...>(new YourGraph<...>(...))}.
*
*
* NOTE: {@code baseGraph} should not be an existing graph. If you want to add an existing graph
* to the graph being built, you should use the {@link #addVertex(Object)} method.
*
* @param baseGraph the graph object to base building on
*/
public GraphBuilder(G baseGraph)
{
super(baseGraph);
}
@Override
protected GraphBuilder self()
{
return this;
}
}