001    package org.apache.commons.graph;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    /**
023     * The {@code MutableGraph} is a graph that supports the addition and removal of {@link Vertex} and {@link Edge}s.
024     *
025     * @param <V> the Graph vertices type
026     * @param <E> the Graph edges type
027     */
028    public interface MutableGraph<V extends Vertex, E extends Edge<V>>
029        extends Graph<V, E>
030    {
031    
032        /**
033         * Adds a feature to the {@link Vertex} attribute of the {@code MutableGraph} object.
034         *
035         * @param v the {@link Vertex} has to be added in this {@code MutableGraph} instance.
036         */
037        void addVertex( V v );
038    
039        /**
040         * Removes the {@link Vertex} from the {@code MutableGraph} object.
041         *
042         * @param v the {@link Vertex} has to be removed from this {@code MutableGraph} instance.
043         */
044        void removeVertex( V v );
045    
046        /**
047         * Adds a feature to the {@link Edge} attribute of the {@code MutableGraph} object
048         *
049         * @param e the {@link Edge} has to be added in this {@code MutableGraph} instance.
050         */
051        void addEdge( E e );
052    
053        /**
054         * Removed the {@link Edge} from the {@code MutableGraph} object.
055         *
056         * @param e the {@link Edge} has to be removed from this {@code MutableGraph} instance.
057         */
058        void removeEdge( E e );
059    
060    }