jakarta.enterprise.context.NormalScope Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jakarta.enterprise.cdi-api Show documentation

APIs for CDI (Contexts and Dependency Injection for Java)

There is a newer version: 4.1.0

Show newest version

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2010, Red Hat, Inc., and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,  
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jakarta.enterprise.context;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

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

/**
 * 
 * Specifies that an annotation type is a normal scope type.
 * 
 * 
 * @author Gavin King
 * @author Pete Muir
 * 
 * @see jakarta.inject.Scope @Scope is used to declare pseudo-scopes.
 */
@Target(ANNOTATION_TYPE)
@Retention(RUNTIME)
@Documented
public @interface NormalScope {

    /**
     * 
     * Determines whether the normal scope type is a passivating scope.
     * 
     * 
     * 
     * A bean is called passivation capable if the container is able to temporarily transfer the state of any idle instance to
     * secondary storage. A passivating scope requires that beans with the scope are passivation capable.
     * 
     * 
     * @return true if the scope type is a passivating scope type
     */
    boolean passivating() default false;

}