capture
[rrq/gorite.git] / com / intendico / gorite / ParallelEndException.java
1 /*********************************************************************
2 Copyright 2012, Ralph Ronnquist.
3
4 This file is part of GORITE.
5
6 GORITE is free software: you can redistribute it and/or modify it
7 under the terms of the Lesser GNU General Public License as published
8 by the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
10
11 GORITE is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without 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 Lesser GNU General Public
17 License along with GORITE.  If not, see <http://www.gnu.org/licenses/>.
18 **********************************************************************/
19
20 package com.intendico.gorite;
21
22 /**
23  * This exception is thrown by an {@link ControlGoal} goal, to be
24  * caught by an enclosing parallel execution, which then cancels all
25  * parallel branches and terminates successfully. The parallel
26  * executions concerned include both {@link ParallelGoal} and {@link
27  * RepeatGoal} goals, as well as {@link TeamGoal} goals directed to
28  * a multi-filled {@link Team.Role}.
29  */
30 public class ParallelEndException extends Exception {
31     
32     /**
33      * Version identity required for serialization.
34      */
35     public static final long serialVersionUID = 1L;
36
37     /**
38      * Constructor.
39      * @param s
40      */
41     public ParallelEndException(String s) {
42         super( s );
43     }
44 }