1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.observation.event

File CancelableEvent.java

 

Code metrics

0
0
0
1
55
8
0
-
-
0
-

Classes

Class Line # Actions
CancelableEvent 28 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.observation.event;
21   
22    /**
23    * This event can be canceled by the receiver. Sender of this event must take care of undoing any changes in this case.
24    *
25    * @version $Id: 2254ac34e65b363474be318ffb1f63b282f4740f $
26    * @since 2.5M1
27    */
 
28    public interface CancelableEvent extends Event
29    {
30    /**
31    * Check if this event was canceled by one of the receivers.
32    *
33    * @return true if the event was canceled, false otherwise
34    */
35    boolean isCanceled();
36   
37    /**
38    * Cancel the event. The actual canceling will be performed by the sender.
39    */
40    void cancel();
41   
42    /**
43    * Cancel the event, giving a reason why. The actual canceling will be performed by the sender.
44    *
45    * @param reason the reason why the event was canceled
46    */
47    void cancel(String reason);
48   
49    /**
50    * Get the reason why the event was canceled.
51    *
52    * @return reason for cancel or null of the event was not canceled or canceled using {@link #cancel()}
53    */
54    String getReason();
55    }