97 lines
4.2 KiB
Java
97 lines
4.2 KiB
Java
/*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
|
|
*
|
|
* Copyright (c) 2005-2018 Oracle and/or its affiliates. All rights reserved.
|
|
*
|
|
* The contents of this file are subject to the terms of either the GNU
|
|
* General Public License Version 2 only ("GPL") or the Common Development
|
|
* and Distribution License("CDDL") (collectively, the "License"). You
|
|
* may not use this file except in compliance with the License. You can
|
|
* obtain a copy of the License at
|
|
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
|
|
* or LICENSE.txt. See the License for the specific
|
|
* language governing permissions and limitations under the License.
|
|
*
|
|
* When distributing the software, include this License Header Notice in each
|
|
* file and include the License file at LICENSE.txt.
|
|
*
|
|
* GPL Classpath Exception:
|
|
* Oracle designates this particular file as subject to the "Classpath"
|
|
* exception as provided by Oracle in the GPL Version 2 section of the License
|
|
* file that accompanied this code.
|
|
*
|
|
* Modifications:
|
|
* If applicable, add the following below the License Header, with the fields
|
|
* enclosed by brackets [] replaced by your own identifying information:
|
|
* "Portions Copyright [year] [name of copyright owner]"
|
|
*
|
|
* Contributor(s):
|
|
* If you wish your version of this file to be governed by only the CDDL or
|
|
* only the GPL Version 2, indicate your decision by adding "[Contributor]
|
|
* elects to include this software in this distribution under the [CDDL or GPL
|
|
* Version 2] license." If you don't indicate a single choice of license, a
|
|
* recipient has the option to distribute your version of this file under
|
|
* either the CDDL, the GPL Version 2 or to extend the choice of license to
|
|
* its licensees as provided above. However, if you add GPL Version 2 code
|
|
* and therefore, elected the GPL Version 2 license, then the option applies
|
|
* only if the new code is made subject to such option by the copyright
|
|
* holder.
|
|
*/
|
|
|
|
package javax.annotation;
|
|
|
|
import static java.lang.annotation.ElementType.METHOD;
|
|
import static java.lang.annotation.RetentionPolicy.RUNTIME;
|
|
|
|
import java.lang.annotation.Documented;
|
|
import java.lang.annotation.Retention;
|
|
import java.lang.annotation.Target;
|
|
|
|
/**
|
|
* The <code>PreDestroy</code> annotation is used on a method as a callback
|
|
* notification to signal that the instance is in the process of being removed
|
|
* by the container. The method annotated with <code>PreDestroy</code> is
|
|
* typically used to release resources that it has been holding. This annotation
|
|
* must be supported by all container-managed objects that support the use of
|
|
* the <code>PostConstruct</code> annotation except the Java EE application
|
|
* client. The method on which the <code>PreDestroy</code> annotation is applied
|
|
* must fulfill all of the following criteria:
|
|
* <ul>
|
|
* <li>The method must not have any parameters except in the case of
|
|
* interceptors in which case it takes an <code>InvocationContext</code> object
|
|
* as defined by the Interceptors specification.</li>
|
|
* <li>The method defined on an interceptor class or superclass of an
|
|
* interceptor class must have one of the following signatures:
|
|
* <p>
|
|
* void <METHOD>(InvocationContext)
|
|
* <p>
|
|
* Object <METHOD>(InvocationContext) throws Exception
|
|
* <p>
|
|
* <i>Note: A PreDestroy interceptor method must not throw application
|
|
* exceptions, but it may be declared to throw checked exceptions including the
|
|
* java.lang.Exception if the same interceptor method interposes on business or
|
|
* timeout methods in addition to lifecycle events. If a PreDestroy interceptor
|
|
* method returns a value, it is ignored by the container.</i></li>
|
|
* <li>The method defined on a non-interceptor class must have the following
|
|
* signature:
|
|
* <p>
|
|
* void <METHOD>()</li>
|
|
* <li>The method on which PreDestroy is applied may be public, protected,
|
|
* package private or private.</li>
|
|
* <li>The method must not be static.</li>
|
|
* <li>The method should not be final.</li>
|
|
* <li>If the method throws an unchecked exception it is ignored by the
|
|
* container.</li>
|
|
* </ul>
|
|
*
|
|
* @see javax.annotation.PostConstruct
|
|
* @see javax.annotation.Resource
|
|
* @since 1.6, Common Annotations 1.0
|
|
*/
|
|
|
|
@Documented
|
|
@Retention(RUNTIME)
|
|
@Target(METHOD)
|
|
public @interface PreDestroy {
|
|
}
|