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

Fri, 04 Oct 2013 16:21:34 +0100

author
mkos
date
Fri, 04 Oct 2013 16:21:34 +0100
changeset 408
b0610cd08440
parent 368
0989ad8c0860
child 637
9c07ef4934dd
permissions
-rw-r--r--

8025054: Update JAX-WS RI integration to 2.2.9-b130926.1035
Reviewed-by: chegar

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

mercurial