Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
SuspendableHandler |
|
| 0.0;0 |
1 | /* | |
2 | * | |
3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | |
4 | * | |
5 | * Copyright 2007-2008 Sun Microsystems, Inc. All rights reserved. | |
6 | * | |
7 | * The contents of this file are subject to the terms of either the GNU | |
8 | * General Public License Version 2 only ("GPL") or the Common Development | |
9 | * and Distribution License("CDDL") (collectively, the "License"). You | |
10 | * may not use this file except in compliance with the License. You can obtain | |
11 | * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html | |
12 | * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific | |
13 | * language governing permissions and limitations under the License. | |
14 | * | |
15 | * When distributing the software, include this License Header Notice in each | |
16 | * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt. | |
17 | * Sun designates this particular file as subject to the "Classpath" exception | |
18 | * as provided by Sun in the GPL Version 2 section of the License file that | |
19 | * accompanied this code. If applicable, add the following below the License | |
20 | * Header, with the fields enclosed by brackets [] replaced by your own | |
21 | * identifying information: "Portions Copyrighted [year] | |
22 | * [name of copyright owner]" | |
23 | * | |
24 | * Contributor(s): | |
25 | * | |
26 | * If you wish your version of this file to be governed by only the CDDL or | |
27 | * only the GPL Version 2, indicate your decision by adding "[Contributor] | |
28 | * elects to include this software in this distribution under the [CDDL or GPL | |
29 | * Version 2] license." If you don't indicate a single choice of license, a | |
30 | * recipient has the option to distribute your version of this file under | |
31 | * either the CDDL, the GPL Version 2 or to extend the choice of license to | |
32 | * its licensees as provided above. However, if you add GPL Version 2 code | |
33 | * and therefore, elected the GPL Version 2 license, then the option applies | |
34 | * only if the new code is made subject to such option by the copyright | |
35 | * holder. | |
36 | * | |
37 | */ | |
38 | package com.sun.grizzly.suspendable; | |
39 | ||
40 | /** | |
41 | * A handler for consuming the result of an suspendable operation. | |
42 | * | |
43 | * The suspendable operations defined in this package allow a suspendable handler | |
44 | * to be specified to consume the result of an suspensable operation. | |
45 | * When an operation completes the handler's {@link #interupted,#resumed,#cancelled} | |
46 | * method is invoked with the result. | |
47 | * | |
48 | * @author Jeanfrancois Arcand | |
49 | * @param A An attachment. | |
50 | */ | |
51 | public interface SuspendableHandler<A> { | |
52 | ||
53 | ||
54 | /** | |
55 | * Invoked when a suspendable is cancelled (by calling {@link Suspendable#cancel}) | |
56 | * @param attachment | |
57 | */ | |
58 | public void interupted(A attachment); | |
59 | ||
60 | ||
61 | /** | |
62 | * Invoked when a suspendable is resumed (by calling {@link Suspendable#resume}) | |
63 | * @param attachment | |
64 | */ | |
65 | public void resumed(A attachment); | |
66 | ||
67 | ||
68 | /** | |
69 | * Invoked when a suspendable is expired (using the timeout value specified | |
70 | * by calling {@link SuspendableFilter#suspend}) | |
71 | * @param attachment | |
72 | */ | |
73 | public void expired(A attachment); | |
74 | } |