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 MutableDirectedGraph} is a directed graph that supports the addition and removal of
024     * {@link Vertex} and {@link Edge}s.
025     *
026     * @param <V> the Graph vertices type
027     * @param <E> the Graph edges type
028     */
029    public interface MutableDirectedGraph<V extends Vertex, E extends Edge<V>>
030        extends DirectedGraph<V, E>
031    {
032    
033        /**
034         * Adds a feature to the {@link Vertex} attribute of the {@code MutableDirectedGraph} object.
035         *
036         * @param v the {@link Vertex} has to be added in this {@code MutableDirectedGraph} instance.
037         */
038        public void addVertex( V v )
039            throws GraphException;
040    
041        /**
042         * Adds a feature to the {@link Edge} attribute of the {@code MutableDirectedGraph} object.
043         *
044         * @param e the {@link Edge} has to be added to this {@code MutableDirectedGraph} object.
045         * @param source the input {@link Edge} source
046         * @param target the input {@link Edge} target
047         */
048        public void addEdge( E e, V source, V target )
049            throws GraphException;
050    
051        /**
052         * Removes the {@link Vertex} from the {@code MutableGraph} object.
053         *
054         * @param v the {@link Vertex} has to be removed from this {@code MutableDirectedGraph} instance.
055         */
056        public void removeVertex( V v )
057            throws GraphException;
058    
059        /**
060         * Adds a feature to the {@link Edge} attribute of the {@code MutableDirectedGraph} object
061         *
062         * @param e the {@link Edge} has to be added in this {@code MutableDirectedGraph} instance.
063         */
064        public void removeEdge( E e )
065            throws GraphException;
066    
067    }