/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997, 2015 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://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/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 packager/legal/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.ejb;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
import java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.*;
/**
* Designates a method on a stateless session bean class, a singleton
* session bean class, a message driven bean class, or an EJB 2.x entity bean
* class that should receive EJB timer expirations for that bean.
* <p>
* The method to which the <code>Timeout</code> annotation is applied
* must have one of the following signatures, where <code><METHOD></code>
* designates the method name:
* <p>
* <pre>
* void <METHOD>()
* void <METHOD>(Timer timer)
* </pre>
*
* A timeout callback method can have public, private, protected, or package level
* access. A timeout callback method must not be declared as final or static.
* Timeout callback methods must not throw application exceptions.
* <p>
* If the bean implements the <code>TimedObject</code> interface, the
* <code>Timeout</code> annotation can only be applied to the
* <code>ejbTimeout</code> method.
*
* @since EJB 3.0
*/
@Target(METHOD)
@Retention(RUNTIME)
public @interface Timeout {}