1 package org.apache.commons.graph;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 /**
23 * The {@code MutableDirectedGraph} is a directed graph that supports the addition and removal of
24 * {@link Vertex} and {@link Edge}s.
25 *
26 * @param <V> the Graph vertices type
27 * @param <E> the Graph edges type
28 */
29 public interface MutableDirectedGraph<V extends Vertex, E extends Edge<V>>
30 extends DirectedGraph<V, E>
31 {
32
33 /**
34 * Adds a feature to the {@link Vertex} attribute of the {@code MutableDirectedGraph} object.
35 *
36 * @param v the {@link Vertex} has to be added in this {@code MutableDirectedGraph} instance.
37 */
38 public void addVertex( V v )
39 throws GraphException;
40
41 /**
42 * Adds a feature to the {@link Edge} attribute of the {@code MutableDirectedGraph} object.
43 *
44 * @param e the {@link Edge} has to be added to this {@code MutableDirectedGraph} object.
45 * @param source the input {@link Edge} source
46 * @param target the input {@link Edge} target
47 */
48 public void addEdge( E e, V source, V target )
49 throws GraphException;
50
51 /**
52 * Removes the {@link Vertex} from the {@code MutableGraph} object.
53 *
54 * @param v the {@link Vertex} has to be removed from this {@code MutableDirectedGraph} instance.
55 */
56 public void removeVertex( V v )
57 throws GraphException;
58
59 /**
60 * Adds a feature to the {@link Edge} attribute of the {@code MutableDirectedGraph} object
61 *
62 * @param e the {@link Edge} has to be added in this {@code MutableDirectedGraph} instance.
63 */
64 public void removeEdge( E e )
65 throws GraphException;
66
67 }