 Type Parameters:
V
 the graph vertex typeE
 the graph edge type
 All Implemented Interfaces:
Serializable
,Cloneable
,Graph<V,
E>
ImmutableNetwork
.
Since the underlying network is immutable, the resulting graph is unmodifiable.
Example usage:
MutableNetwork<String, DefaultEdge> mutableNetwork = NetworkBuilder.directed().allowsParallelEdges(true).allowsSelfLoops(true).build(); mutableNetwork.addNode("v1"); ImmutableNetworkGraph<String, DefaultEdge> immutableNetwork = ImmutableNetwork.copyOf(mutableNetwork); Graph<String, DefaultEdge> graph = new ImmutableNetworkAdapter<>(immutableNetwork);
 Author:
 Dimitrios Michail
 See Also:

Field Summary
Fields inherited from class org.jgrapht.graph.guava.BaseNetworkAdapter
edgeSupplier, LOOPS_NOT_ALLOWED, network, unmodifiableEdgeSet, unmodifiableVertexSet, vertexOrder, vertexOrderMethod, vertexSupplier
Fields inherited from interface org.jgrapht.Graph
DEFAULT_EDGE_WEIGHT

Constructor Summary
ConstructorDescriptionImmutableNetworkAdapter
(com.google.common.graph.ImmutableNetwork<V, E> network) Create a new network adapter. 
Method Summary
Modifier and TypeMethodDescriptionCreates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge.boolean
Adds the specified edge to this graph, going from the source vertex to the target vertex.Creates a new vertex in this graph and returns it.boolean
Adds the specified vertex to this graph if not already present.clone()
Returns a shallow copy of this graph instance.double
getEdgeWeight
(E e) Returns the weight assigned to a given edge.getType()
Get the graph type.boolean
removeEdge
(E e) Removes the specified edge from the graph.removeEdge
(V sourceVertex, V targetVertex) Removes an edge going from source vertex to target vertex, if such vertices and such edge exist in this graph.boolean
removeVertex
(V v) Removes the specified vertex from this graph including all its touching edges if present.void
setEdgeWeight
(E e, double weight) Assigns a weight to an edge.Methods inherited from class org.jgrapht.graph.guava.BaseNetworkAdapter
containsEdge, containsVertex, createVertexOrder, degreeOf, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeSource, getEdgeSupplier, getEdgeTarget, getVertexSupplier, incomingEdgesOf, inDegreeOf, outDegreeOf, outgoingEdgesOf, setEdgeSupplier, setVertexSupplier, vertexSet
Methods inherited from class org.jgrapht.graph.AbstractGraph
assertVertexExist, containsEdge, equals, hashCode, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toString, toStringFromSets
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.jgrapht.Graph
containsEdge, containsEdge, containsVertex, degreeOf, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeSource, getEdgeSupplier, getEdgeTarget, getVertexSupplier, incomingEdgesOf, inDegreeOf, iterables, outDegreeOf, outgoingEdgesOf, removeAllEdges, removeAllEdges, removeAllVertices, setEdgeWeight, vertexSet

Field Details

GRAPH_IS_IMMUTABLE
 See Also:


Constructor Details

ImmutableNetworkAdapter
Create a new network adapter. Parameters:
network
 the immutable network


Method Details

addEdge
Description copied from interface:Graph
Creates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge. Some graphs do not allow edgemultiplicity. In such cases, if the graph already contains an edge from the specified source to the specified target, then this method does not change the graph and returnsnull
.The source and target vertices must already be contained in this graph. If they are not found in graph
IllegalArgumentException
is thrown.This method creates the new edge
e
using this graph's edge supplier (seeGraph.getEdgeSupplier()
). For the new edge to be addede
must not be equal to any other edge the graph (even if the graph allows edgemultiplicity). More formally, the graph must not contain any edgee2
such thate2.equals(e)
. If suche2
is found then the newly created edgee
is abandoned, the method leaves this graph unchanged and returnsnull
.If the underlying graph implementation's
Graph.getEdgeSupplier()
returnsnull
, then this method cannot create edges and throws anUnsupportedOperationException
. 
addEdge
Description copied from interface:Graph
Adds the specified edge to this graph, going from the source vertex to the target vertex. More formally, adds the specified edge,e
, to this graph if this graph contains no edgee2
such thate2.equals(e)
. If this graph already contains such an edge, the call leaves this graph unchanged and returnsfalse
. Some graphs do not allow edgemultiplicity. In such cases, if the graph already contains an edge from the specified source to the specified target, then this method does not change the graph and returnsfalse
. If the edge was added to the graph, returnstrue
.The source and target vertices must already be contained in this graph. If they are not found in graph IllegalArgumentException is thrown.

addVertex
Description copied from interface:Graph
Creates a new vertex in this graph and returns it.This method creates the new vertex
v
using this graph's vertex supplier (seeGraph.getVertexSupplier()
). For the new vertex to be addedv
must not be equal to any other vertex in the graph. More formally, the graph must not contain any vertexv2
such thatv2.equals(v)
. If suchv2
is found then the newly created vertexv
is abandoned, the method leaves this graph unchanged and throws anIllegalArgumentException
.If the underlying graph implementation's
Graph.getVertexSupplier()
returnsnull
, then this method cannot create vertices and throws anUnsupportedOperationException
.Care must also be taken when interchanging calls to methods
Graph.addVertex(Object)
andGraph.addVertex()
. In such a case the user must make sure never to add vertices in the graph using methodGraph.addVertex(Object)
, which are going to be returned in the future by the supplied vertex supplier. Such a sequence will result into anIllegalArgumentException
when calling methodGraph.addVertex()
. 
addVertex
Description copied from interface:Graph
Adds the specified vertex to this graph if not already present. More formally, adds the specified vertex,v
, to this graph if this graph contains no vertexu
such thatu.equals(v)
. If this graph already contains such vertex, the call leaves this graph unchanged and returnsfalse
. In combination with the restriction on constructors, this ensures that graphs never contain duplicate vertices. 
removeEdge
Description copied from interface:Graph
Removes an edge going from source vertex to target vertex, if such vertices and such edge exist in this graph. Returns the edge if removed ornull
otherwise. Specified by:
removeEdge
in interfaceGraph<V,
E>  Parameters:
sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge. Returns:
 The removed edge, or
null
if no edge removed.

removeEdge
Description copied from interface:Graph
Removes the specified edge from the graph. Removes the specified edge from this graph if it is present. More formally, removes an edgee2
such thate2.equals(e)
, if the graph contains such edge. Returnstrue
if the graph contained the specified edge. (The graph will not contain the specified edge once the call returns).If the specified edge is
null
returnsfalse
. Specified by:
removeEdge
in interfaceGraph<V,
E>  Parameters:
e
 edge to be removed from this graph, if present. Returns:
true
if and only if the graph contained the specified edge.

removeVertex
Description copied from interface:Graph
Removes the specified vertex from this graph including all its touching edges if present. More formally, if the graph contains a vertexu
such thatu.equals(v)
, the call removes all edges that touchu
and then removesu
itself. If no suchu
is found, the call leaves the graph unchanged. Returnstrue
if the graph contained the specified vertex. (The graph will not contain the specified vertex once the call returns).If the specified vertex is
null
returnsfalse
. Specified by:
removeVertex
in interfaceGraph<V,
E>  Parameters:
v
 vertex to be removed from this graph, if present. Returns:
true
if the graph contained the specified vertex;false
otherwise.

getEdgeWeight
Description copied from interface:Graph
Returns the weight assigned to a given edge. Unweighted graphs return 1.0 (as defined byGraph.DEFAULT_EDGE_WEIGHT
), allowing weightedgraph algorithms to apply to them when meaningful. Specified by:
getEdgeWeight
in interfaceGraph<V,
E>  Overrides:
getEdgeWeight
in classBaseNetworkAdapter<V,
E, com.google.common.graph.ImmutableNetwork<V, E>>  Parameters:
e
 edge of interest Returns:
 edge weight

setEdgeWeight
Description copied from interface:Graph
Assigns a weight to an edge. Specified by:
setEdgeWeight
in interfaceGraph<V,
E>  Parameters:
e
 edge on which to set weightweight
 new weight for edge

getType
Description copied from interface:Graph
Get the graph type. The graph type can be used to query for additional metadata such as whether the graph supports directed or undirected edges, selfloops, multiple (parallel) edges, weights, etc. 
clone
Returns a shallow copy of this graph instance. Neither edges nor vertices are cloned. Overrides:
clone
in classObject
 Returns:
 a shallow copy of this graph.
 Throws:
RuntimeException
 in case the clone is not supported See Also:
