nl.topicus.jdbc.shaded.com.google.common.graph.MutableValueGraph Maven / Gradle / Ivy
Show all versions of spanner-jdbc Show documentation
/*
* Copyright (C) 2016 The Guava 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 nl.topicus.jdbc.shaded.com.google.common.graph;
import nl.topicus.jdbc.shaded.com.google.common.annotations.Beta;
import nl.topicus.jdbc.shaded.com.google.errorprone.annotations.CanIgnoreReturnValue;
/**
* A subinterface of {@link ValueGraph} which adds mutation methods. When mutation is not required,
* users should prefer the {@link ValueGraph} interface.
*
* @author James Sexton
* @param Node parameter type
* @param Value parameter type
* @since 20.0
*/
@Beta
public interface MutableValueGraph extends ValueGraph {
/**
* Adds {@code node} if it is not already present.
*
* Nodes must be unique, just as {@code Map} keys must be. They must also be non-null.
*
* @return {@code true} if the graph was modified as a result of this call
*/
@CanIgnoreReturnValue
boolean addNode(N node);
/**
* Adds an edge connecting {@code nodeU} to {@code nodeV} if one is not already present; associate
* that edge with {@code value}. In an undirected graph, the edge will also connect {@code nodeV}
* to {@code nodeU}.
*
*
Values do not have to be unique. However, values must be non-null.
*
*
Behavior if {@code nodeU} and {@code nodeV} are not already present in this graph is
* implementation-dependent. Suggested behaviors include (a) silently {@link #addNode(Object)
* adding} {@code nodeU} and {@code nodeV} to the graph (this is the behavior of the default
* implementations) or (b) throwing {@code IllegalArgumentException}.
*
* @return the value previously associated with the edge connecting {@code nodeU} to {@code
* nodeV}, or null if there was no such edge.
* @throws IllegalArgumentException if the introduction of the edge would violate {@link
* #allowsSelfLoops()}
*/
@CanIgnoreReturnValue
V putEdgeValue(N nodeU, N nodeV, V value);
/**
* Removes {@code node} if it is present; all edges incident to {@code node} will also be removed.
*
* @return {@code true} if the graph was modified as a result of this call
*/
@CanIgnoreReturnValue
boolean removeNode(Object node);
/**
* Removes the edge connecting {@code nodeU} to {@code nodeV}, if it is present.
*
* @return the value previously associated with the edge connecting {@code nodeU} to {@code
* nodeV}, or null if there was no such edge.
*/
@CanIgnoreReturnValue
V removeEdge(Object nodeU, Object nodeV);
}