ohair@286: /*
alanb@368:  * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package javax.annotation;
ohair@286: 
ohair@286: import java.lang.annotation.*;
ohair@286: import static java.lang.annotation.ElementType.*;
ohair@286: import static java.lang.annotation.RetentionPolicy.*;
ohair@286: 
ohair@286: /**
ohair@286:  * The PreDestroy annotation is used on methods as a callback notification to
ohair@286:  * signal that the instance is in the process of being removed by the
ohair@286:  * container. The method annotated with PreDestroy is typically used to
ohair@286:  * release resources that it has been holding. This annotation MUST be
ohair@286:  * supported by all container managed objects that support PostConstruct
ohair@286:  * except the application client container in Java EE 5. The method on which
ohair@286:  * the PreDestroy annotation is applied MUST fulfill all of the following
mkos@408:  * criteria:
mkos@408:  * <p>
mkos@408:  * <ul>
mkos@408:  * <li>The method MUST NOT have any parameters except in the case of
mkos@408:  * interceptors in which case it takes an InvocationContext object as
mkos@408:  * defined by the Interceptors specification.</li>
mkos@408:  * <li>The method defined on an interceptor class MUST HAVE one of the
mkos@408:  * following signatures:
mkos@408:  * <p>
mkos@408:  * void &#060;METHOD&#062;(InvocationContext)
mkos@408:  * <p>
mkos@408:  * Object &#060;METHOD&#062;(InvocationContext) throws Exception
mkos@408:  * <p>
mkos@408:  * <i>Note: A PreDestroy interceptor method must not throw application
mkos@408:  * exceptions, but it may be declared to throw checked exceptions including
mkos@408:  * the java.lang.Exception if the same interceptor method interposes on
mkos@408:  * business or timeout methods in addition to lifecycle events. If a
mkos@408:  * PreDestroy interceptor method returns a value, it is ignored by
mkos@408:  * the container.</i>
mkos@408:  * </li>
mkos@408:  * <li>The method defined on a non-interceptor class MUST HAVE the
mkos@408:  * following signature:
mkos@408:  * <p>
mkos@408:  * void &#060;METHOD&#062;()
mkos@408:  * </li>
alanb@368:  * <li>The method on which PreDestroy is applied MAY be public, protected,
alanb@368:  * package private or private.</li>
alanb@368:  * <li>The method MUST NOT be static.</li>
alanb@368:  * <li>The method MAY be final.</li>
alanb@368:  * <li>If the method throws an unchecked exception it is ignored except in the
alanb@368:  * case of EJBs where the EJB can handle exceptions.</li>
mkos@408:  * </ul>
ohair@286:  *
ohair@286:  * @see javax.annotation.PostConstruct
ohair@286:  * @see javax.annotation.Resource
ohair@286:  * @since Common Annotations 1.0
ohair@286:  */
ohair@286: 
ohair@286: @Documented
ohair@286: @Retention (RUNTIME)
ohair@286: @Target(METHOD)
ohair@286: public @interface PreDestroy {
ohair@286: }