| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Edge |
|
| 1.0;1 |
| 1 | /* | |
| 2 | ||
| 3 | dsh-graph Directed graph interface and implementation. | |
| 4 | Copyright (c) 2004-2012 held jointly by the individual authors. | |
| 5 | ||
| 6 | This library is free software; you can redistribute it and/or modify it | |
| 7 | under the terms of the GNU Lesser General Public License as published | |
| 8 | by the Free Software Foundation; either version 3 of the License, or (at | |
| 9 | your option) any later version. | |
| 10 | ||
| 11 | This library is distributed in the hope that it will be useful, but WITHOUT | |
| 12 | ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or | |
| 13 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public | |
| 14 | License for more details. | |
| 15 | ||
| 16 | You should have received a copy of the GNU Lesser General Public License | |
| 17 | along with this library; if not, write to the Free Software Foundation, | |
| 18 | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. | |
| 19 | ||
| 20 | > http://www.fsf.org/licensing/licenses/lgpl.html | |
| 21 | > http://www.opensource.org/licenses/lgpl-license.php | |
| 22 | ||
| 23 | */ | |
| 24 | package org.dishevelled.graph; | |
| 25 | ||
| 26 | /** | |
| 27 | * Typed directed graph edge. | |
| 28 | * | |
| 29 | * @param <N> node value type | |
| 30 | * @param <E> edge value type | |
| 31 | * @author Michael Heuer | |
| 32 | * @version $Revision$ $Date$ | |
| 33 | */ | |
| 34 | public interface Edge<N, E> | |
| 35 | { | |
| 36 | ||
| 37 | /** | |
| 38 | * Return the value at this edge. | |
| 39 | * | |
| 40 | * @return the value at this edge | |
| 41 | */ | |
| 42 | E getValue(); | |
| 43 | ||
| 44 | /** | |
| 45 | * Set the value at this edge to <code>value</code> (optional operation). | |
| 46 | * | |
| 47 | * @param value value at this edge | |
| 48 | * @throws UnsupportedOperationException if the <code>setValue(E)</code> | |
| 49 | * operation is not supported by this edge | |
| 50 | */ | |
| 51 | void setValue(E value); | |
| 52 | ||
| 53 | /** | |
| 54 | * Return the source node for this edge. The source node will not be null. | |
| 55 | * | |
| 56 | * @return the source node for this edge | |
| 57 | */ | |
| 58 | Node<N, E> source(); | |
| 59 | ||
| 60 | /** | |
| 61 | * Return the target node for this edge. The target node will not be null. | |
| 62 | * | |
| 63 | * @return the target node for this edge | |
| 64 | */ | |
| 65 | Node<N, E> target(); | |
| 66 | } |