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