src/share/jaxws_classes/javax/annotation/PreDestroy.java

changeset 0
373ffda63c9a
child 637
9c07ef4934dd
equal deleted inserted replaced
-1:000000000000 0:373ffda63c9a
1 /*
2 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code 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 General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package javax.annotation;
27
28 import java.lang.annotation.*;
29 import static java.lang.annotation.ElementType.*;
30 import static java.lang.annotation.RetentionPolicy.*;
31
32 /**
33 * The PreDestroy annotation is used on methods as a callback notification to
34 * signal that the instance is in the process of being removed by the
35 * container. The method annotated with PreDestroy is typically used to
36 * release resources that it has been holding. This annotation MUST be
37 * supported by all container managed objects that support PostConstruct
38 * except the application client container in Java EE 5. The method on which
39 * the PreDestroy annotation is applied MUST fulfill all of the following
40 * criteria:
41 * <p>
42 * <ul>
43 * <li>The method MUST NOT have any parameters except in the case of
44 * interceptors in which case it takes an InvocationContext object as
45 * defined by the Interceptors specification.</li>
46 * <li>The method defined on an interceptor class MUST HAVE one of the
47 * following signatures:
48 * <p>
49 * void &#060;METHOD&#062;(InvocationContext)
50 * <p>
51 * Object &#060;METHOD&#062;(InvocationContext) throws Exception
52 * <p>
53 * <i>Note: A PreDestroy interceptor method must not throw application
54 * exceptions, but it may be declared to throw checked exceptions including
55 * the java.lang.Exception if the same interceptor method interposes on
56 * business or timeout methods in addition to lifecycle events. If a
57 * PreDestroy interceptor method returns a value, it is ignored by
58 * the container.</i>
59 * </li>
60 * <li>The method defined on a non-interceptor class MUST HAVE the
61 * following signature:
62 * <p>
63 * void &#060;METHOD&#062;()
64 * </li>
65 * <li>The method on which PreDestroy is applied MAY be public, protected,
66 * package private or private.</li>
67 * <li>The method MUST NOT be static.</li>
68 * <li>The method MAY be final.</li>
69 * <li>If the method throws an unchecked exception it is ignored except in the
70 * case of EJBs where the EJB can handle exceptions.</li>
71 * </ul>
72 *
73 * @see javax.annotation.PostConstruct
74 * @see javax.annotation.Resource
75 * @since Common Annotations 1.0
76 */
77
78 @Documented
79 @Retention (RUNTIME)
80 @Target(METHOD)
81 public @interface PreDestroy {
82 }

mercurial