01 /*
02 * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 //Copyright Sun Microsystems Inc. 2004 - 2005.
27 package javax.annotation;
28
29 import java.lang.annotation.*;
30 import static java.lang.annotation.ElementType.*;
31 import static java.lang.annotation.RetentionPolicy.*;
32
33 /**
34 * The PreDestroy annotation is used on methods as a callback notification to
35 * signal that the instance is in the process of being removed by the
36 * container. The method annotated with PreDestroy is typically used to
37 * release resources that it has been holding. This annotation MUST be
38 * supported by all container managed objects that support PostConstruct
39 * except the application client container in Java EE 5. The method on which
40 * the PreDestroy annotation is applied MUST fulfill all of the following
41 * criteria -
42 * - The method MUST NOT have any parameters except in the case of EJB
43 * interceptors in which case it takes an InvocationContext object as defined
44 * by the EJB specification.
45 * - The return type of the method MUST be void.
46 * - The method MUST NOT throw a checked exception.
47 * - The method on which PreDestroy is applied MAY be public, protected,
48 * package private or private.
49 * - The method MUST NOT be static.
50 * - The method MAY be final.
51 * - If the method throws an unchecked exception it is ignored except in the
52 * case of EJBs where the EJB can handle exceptions.
53 *
54 * @see javax.annotation.PostConstruct
55 * @see javax.annotation.Resource
56 * @since Common Annotations 1.0
57 */
58
59 @Documented
60 @Retention(RUNTIME)
61 @Target(METHOD)
62 public @interface PreDestroy {
63 }
|