jakarta.ejb.Remove Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ejb-api Show documentation

Jakarta Enterprise Beans

There is a newer version: 1.2.2.1-jre17

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.ejb;

import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.ElementType;

import java.lang.annotation.Target;
import java.lang.annotation.Retention;

/**
 * Applied to a business method of a stateful session bean class to indicate to the container that the stateful session
 * bean is to be removed by the container after completion of the method.
 *
 * @since EJB 3.0
 */

@Target({ ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface Remove {

    /**
     * If true, the stateful session bean will not be removed if an exception is thrown from the designated method.
     *
     * @return a boolean.
     */
    boolean retainIfException() default false;

}