Class ForwardingValueGraph<N,V>
- java.lang.Object
-
- com.google.common.graph.AbstractBaseGraph<N>
-
- com.google.common.graph.AbstractValueGraph<N,V>
-
- com.google.common.graph.ForwardingValueGraph<N,V>
-
- All Implemented Interfaces:
BaseGraph<N>
,PredecessorsFunction<N>
,SuccessorsFunction<N>
,ValueGraph<N,V>
- Direct Known Subclasses:
Graphs.TransposedValueGraph
abstract class ForwardingValueGraph<N,V> extends AbstractValueGraph<N,V>
A class to allowValueGraph
implementations to be backed by a provided delegate. This is not currently planned to be released as a general-purpose forwarding class.
-
-
Constructor Summary
Constructors Constructor Description ForwardingValueGraph()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.util.Set<N>
adjacentNodes(N node)
Returns the nodes which have an incident edge in common withnode
in this graph.boolean
allowsSelfLoops()
Returns true if this graph allows self-loops (edges that connect a node to itself).int
degree(N node)
Returns the count ofnode
's incident edges, counting self-loops twice (equivalently, the number of times an edge touchesnode
).protected abstract ValueGraph<N,V>
delegate()
protected long
edgeCount()
Defer toAbstractBaseGraph.edges()
(based onsuccessors(Object)
) for full edges() implementation.java.util.Optional<V>
edgeValue(EndpointPair<N> endpoints)
Returns the value of the edge that connectsendpoints
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsOptional.empty()
.java.util.Optional<V>
edgeValue(N nodeU, N nodeV)
Returns the value of the edge that connectsnodeU
tonodeV
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsOptional.empty()
.V
edgeValueOrDefault(EndpointPair<N> endpoints, V defaultValue)
Returns the value of the edge that connectsendpoints
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsdefaultValue
.V
edgeValueOrDefault(N nodeU, N nodeV, V defaultValue)
Returns the value of the edge that connectsnodeU
tonodeV
, if one is present; otherwise, returnsdefaultValue
.boolean
hasEdgeConnecting(EndpointPair<N> endpoints)
Returns true if there is an edge that directly connectsendpoints
(in the order, if any, specified byendpoints
).boolean
hasEdgeConnecting(N nodeU, N nodeV)
Returns true if there is an edge that directly connectsnodeU
tonodeV
.int
inDegree(N node)
Returns the count ofnode
's incoming edges (equal topredecessors(node).size()
) in a directed graph.boolean
isDirected()
Returns true if the edges in this graph are directed.ElementOrder<N>
nodeOrder()
Returns the order of iteration for the elements ofValueGraph.nodes()
.java.util.Set<N>
nodes()
Returns all nodes in this graph, in the order specified byValueGraph.nodeOrder()
.int
outDegree(N node)
Returns the count ofnode
's outgoing edges (equal tosuccessors(node).size()
) in a directed graph.java.util.Set<N>
predecessors(N node)
Returns all nodes in this graph adjacent tonode
which can be reached by traversingnode
's incoming edges against the direction (if any) of the edge.java.util.Set<N>
successors(N node)
Returns all nodes in this graph adjacent tonode
which can be reached by traversingnode
's outgoing edges in the direction (if any) of the edge.-
Methods inherited from class com.google.common.graph.AbstractValueGraph
asGraph, equals, hashCode, toString
-
Methods inherited from class com.google.common.graph.AbstractBaseGraph
edges, incidentEdges, isOrderingCompatible, validateEndpoints
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.google.common.graph.ValueGraph
edges, incidentEdges
-
-
-
-
Method Detail
-
delegate
protected abstract ValueGraph<N,V> delegate()
-
nodes
public java.util.Set<N> nodes()
Description copied from interface:ValueGraph
Returns all nodes in this graph, in the order specified byValueGraph.nodeOrder()
.
-
edgeCount
protected long edgeCount()
Defer toAbstractBaseGraph.edges()
(based onsuccessors(Object)
) for full edges() implementation.- Overrides:
edgeCount
in classAbstractBaseGraph<N>
-
isDirected
public boolean isDirected()
Description copied from interface:ValueGraph
Returns true if the edges in this graph are directed. Directed edges connect asource node
to atarget node
, while undirected edges connect a pair of nodes to each other.
-
allowsSelfLoops
public boolean allowsSelfLoops()
Description copied from interface:ValueGraph
Returns true if this graph allows self-loops (edges that connect a node to itself). Attempting to add a self-loop to a graph that does not allow them will throw anIllegalArgumentException
.
-
nodeOrder
public ElementOrder<N> nodeOrder()
Description copied from interface:ValueGraph
Returns the order of iteration for the elements ofValueGraph.nodes()
.
-
adjacentNodes
public java.util.Set<N> adjacentNodes(N node)
Description copied from interface:ValueGraph
Returns the nodes which have an incident edge in common withnode
in this graph.This is equal to the union of
ValueGraph.predecessors(Object)
andValueGraph.successors(Object)
.
-
predecessors
public java.util.Set<N> predecessors(N node)
Description copied from interface:ValueGraph
Returns all nodes in this graph adjacent tonode
which can be reached by traversingnode
's incoming edges against the direction (if any) of the edge.In an undirected graph, this is equivalent to
ValueGraph.adjacentNodes(Object)
.
-
successors
public java.util.Set<N> successors(N node)
Description copied from interface:ValueGraph
Returns all nodes in this graph adjacent tonode
which can be reached by traversingnode
's outgoing edges in the direction (if any) of the edge.In an undirected graph, this is equivalent to
ValueGraph.adjacentNodes(Object)
.This is not the same as "all nodes reachable from
node
by following outgoing edges". For that functionality, seeGraphs.reachableNodes(Graph, Object)
.
-
degree
public int degree(N node)
Description copied from interface:BaseGraph
Returns the count ofnode
's incident edges, counting self-loops twice (equivalently, the number of times an edge touchesnode
).For directed graphs, this is equal to
inDegree(node) + outDegree(node)
.For undirected graphs, this is equal to
incidentEdges(node).size()
+ (number of self-loops incident tonode
).If the count is greater than
Integer.MAX_VALUE
, returnsInteger.MAX_VALUE
.- Specified by:
degree
in interfaceBaseGraph<N>
- Specified by:
degree
in interfaceValueGraph<N,V>
- Overrides:
degree
in classAbstractBaseGraph<N>
-
inDegree
public int inDegree(N node)
Description copied from interface:BaseGraph
Returns the count ofnode
's incoming edges (equal topredecessors(node).size()
) in a directed graph. In an undirected graph, returns theBaseGraph.degree(Object)
.If the count is greater than
Integer.MAX_VALUE
, returnsInteger.MAX_VALUE
.- Specified by:
inDegree
in interfaceBaseGraph<N>
- Specified by:
inDegree
in interfaceValueGraph<N,V>
- Overrides:
inDegree
in classAbstractBaseGraph<N>
-
outDegree
public int outDegree(N node)
Description copied from interface:BaseGraph
Returns the count ofnode
's outgoing edges (equal tosuccessors(node).size()
) in a directed graph. In an undirected graph, returns theBaseGraph.degree(Object)
.If the count is greater than
Integer.MAX_VALUE
, returnsInteger.MAX_VALUE
.- Specified by:
outDegree
in interfaceBaseGraph<N>
- Specified by:
outDegree
in interfaceValueGraph<N,V>
- Overrides:
outDegree
in classAbstractBaseGraph<N>
-
hasEdgeConnecting
public boolean hasEdgeConnecting(N nodeU, N nodeV)
Description copied from interface:BaseGraph
Returns true if there is an edge that directly connectsnodeU
tonodeV
. This is equivalent tonodes().contains(nodeU) && successors(nodeU).contains(nodeV)
.In an undirected graph, this is equal to
hasEdgeConnecting(nodeV, nodeU)
.- Specified by:
hasEdgeConnecting
in interfaceBaseGraph<N>
- Specified by:
hasEdgeConnecting
in interfaceValueGraph<N,V>
- Overrides:
hasEdgeConnecting
in classAbstractBaseGraph<N>
-
hasEdgeConnecting
public boolean hasEdgeConnecting(EndpointPair<N> endpoints)
Description copied from interface:BaseGraph
Returns true if there is an edge that directly connectsendpoints
(in the order, if any, specified byendpoints
). This is equivalent toedges().contains(endpoints)
.Unlike the other
EndpointPair
-accepting methods, this method does not throw if the endpoints are unordered; it simply returns false. This is for consistency with the behavior ofCollection#contains(Object)
(which does not generally throw if the object cannot be present in the collection), and the desire to have this method's behavior be compatible withedges().contains(endpoints)
.- Specified by:
hasEdgeConnecting
in interfaceBaseGraph<N>
- Specified by:
hasEdgeConnecting
in interfaceValueGraph<N,V>
- Overrides:
hasEdgeConnecting
in classAbstractBaseGraph<N>
-
edgeValue
public java.util.Optional<V> edgeValue(N nodeU, N nodeV)
Description copied from interface:ValueGraph
Returns the value of the edge that connectsnodeU
tonodeV
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsOptional.empty()
.- Specified by:
edgeValue
in interfaceValueGraph<N,V>
- Overrides:
edgeValue
in classAbstractValueGraph<N,V>
-
edgeValue
public java.util.Optional<V> edgeValue(EndpointPair<N> endpoints)
Description copied from interface:ValueGraph
Returns the value of the edge that connectsendpoints
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsOptional.empty()
.If this graph is directed, the endpoints must be ordered.
- Specified by:
edgeValue
in interfaceValueGraph<N,V>
- Overrides:
edgeValue
in classAbstractValueGraph<N,V>
-
edgeValueOrDefault
public V edgeValueOrDefault(N nodeU, N nodeV, V defaultValue)
Description copied from interface:ValueGraph
Returns the value of the edge that connectsnodeU
tonodeV
, if one is present; otherwise, returnsdefaultValue
.In an undirected graph, this is equal to
edgeValueOrDefault(nodeV, nodeU, defaultValue)
.
-
edgeValueOrDefault
public V edgeValueOrDefault(EndpointPair<N> endpoints, V defaultValue)
Description copied from interface:ValueGraph
Returns the value of the edge that connectsendpoints
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsdefaultValue
.If this graph is directed, the endpoints must be ordered.
-
-