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 MutableGraph} is a graph that supports the addition and removal of {@link Vertex} and {@link Edge}s.
24 *
25 * @param <V> the Graph vertices type
26 * @param <E> the Graph edges type
27 */
28 public interface MutableGraph<V extends Vertex, E extends Edge<V>>
29 extends Graph<V, E>
30 {
31
32 /**
33 * Adds a feature to the {@link Vertex} attribute of the {@code MutableGraph} object.
34 *
35 * @param v the {@link Vertex} has to be added in this {@code MutableGraph} instance.
36 */
37 void addVertex( V v );
38
39 /**
40 * Removes the {@link Vertex} from the {@code MutableGraph} object.
41 *
42 * @param v the {@link Vertex} has to be removed from this {@code MutableGraph} instance.
43 */
44 void removeVertex( V v );
45
46 /**
47 * Adds a feature to the {@link Edge} attribute of the {@code MutableGraph} object
48 *
49 * @param e the {@link Edge} has to be added in this {@code MutableGraph} instance.
50 */
51 void addEdge( E e );
52
53 /**
54 * Removed the {@link Edge} from the {@code MutableGraph} object.
55 *
56 * @param e the {@link Edge} has to be removed from this {@code MutableGraph} instance.
57 */
58 void removeEdge( E e );
59
60 }