| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| VetoableGraphChangeListener |
|
| 1.0;1 |
| 1 | /* | |
| 2 | ||
| 3 | dsh-observable-graph Observable decorators for graph interfaces. | |
| 4 | Copyright (c) 2008-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.observable.graph.event; | |
| 25 | ||
| 26 | import java.util.EventListener; | |
| 27 | ||
| 28 | /** | |
| 29 | * A listener that receives notification of vetoable changes about to be made to an observable graph. | |
| 30 | * | |
| 31 | * @param <N> node value type | |
| 32 | * @param <E> edge value type | |
| 33 | * @author Michael Heuer | |
| 34 | * @version $Revision$ $Date$ | |
| 35 | */ | |
| 36 | public interface VetoableGraphChangeListener<N, E> | |
| 37 | extends EventListener | |
| 38 | { | |
| 39 | ||
| 40 | /** | |
| 41 | * Notify this listener that a vetoable clear change is about to be made to the observable graph. | |
| 42 | * | |
| 43 | * @param e graph change event | |
| 44 | * @throws GraphChangeVetoException if this listener wishes the change about to be made | |
| 45 | * to be rolled back | |
| 46 | */ | |
| 47 | void willClear(VetoableGraphChangeEvent<N, E> e) | |
| 48 | throws GraphChangeVetoException; | |
| 49 | ||
| 50 | /** | |
| 51 | * Notify this listener that a vetoable create node change is about to be made to the observable graph. | |
| 52 | * | |
| 53 | * @param e graph change event | |
| 54 | * @throws GraphChangeVetoException if this listener wishes the change about to be made | |
| 55 | * to be rolled back | |
| 56 | */ | |
| 57 | void willCreateNode(VetoableGraphChangeEvent<N, E> e) | |
| 58 | throws GraphChangeVetoException; | |
| 59 | ||
| 60 | /** | |
| 61 | * Notify this listener that a vetoable create edge change is about to be made to the observable graph. | |
| 62 | * | |
| 63 | * @param e graph change event | |
| 64 | * @throws GraphChangeVetoException if this listener wishes the change about to be made | |
| 65 | * to be rolled back | |
| 66 | */ | |
| 67 | void willCreateEdge(VetoableGraphChangeEvent<N, E> e) | |
| 68 | throws GraphChangeVetoException; | |
| 69 | ||
| 70 | /** | |
| 71 | * Notify this listener that a vetoable remove node change is about to be made to the observable graph. | |
| 72 | * | |
| 73 | * @param e graph change event | |
| 74 | * @throws GraphChangeVetoException if this listener wishes the change about to be made | |
| 75 | * to be rolled back | |
| 76 | */ | |
| 77 | void willRemoveNode(VetoableGraphChangeEvent<N, E> e) | |
| 78 | throws GraphChangeVetoException; | |
| 79 | ||
| 80 | /** | |
| 81 | * Notify this listener that a vetoable remove edge change is about to be made to the observable graph. | |
| 82 | * | |
| 83 | * @param e graph change event | |
| 84 | * @throws GraphChangeVetoException if this listener wishes the change about to be made | |
| 85 | * to be rolled back | |
| 86 | */ | |
| 87 | void willRemoveEdge(VetoableGraphChangeEvent<N, E> e) | |
| 88 | throws GraphChangeVetoException; | |
| 89 | } |