javax.enterprise.inject

Interface Instance<T>

Contents
  • Type Parameters:
    T - the required bean type
    All Superinterfaces:
    Iterable<T>, Provider<T>
    All Known Implementing Classes:
    CDI

    public interface Instance<T>
extends Iterable<T>, Provider<T>

    Allows the application to dynamically obtain instances of beans with a specified combination of required type and qualifiers.

    In certain situations, injection is not the most convenient way to obtain a contextual reference. For example, it may not be used when:

    • the bean type or qualifiers vary dynamically at runtime, or
    • depending upon the deployment, there may be no bean which satisfies the type and qualifiers, or
    • we would like to iterate over all beans of a certain type.

    In these situations, an instance of the Instance may be injected: 

     @Inject
 Instance<PaymentProcessor> paymentProcessor;

    Any combination of qualifiers may be specified at the injection point: 

     @Inject
 @PayBy(CHEQUE)
 Instance<PaymentProcessor> chequePaymentProcessor;

    Or, the @Any qualifier may be used, allowing the application to specify qualifiers dynamically: 

     @Inject
 @Any
 Instance<PaymentProcessor> anyPaymentProcessor;

    Finally, the @New qualifier may be used, allowing the application to obtain a @New qualified bean: 

     @Inject
 @New(ChequePaymentProcessor.class)
 Instance<PaymentProcessor> chequePaymentProcessor;

    For an injected Instance:

    • the required type is the type parameter specified at the injection point, and
    • the required qualifiers are the qualifiers specified at the injection point.

    The inherited Provider.get() method returns a contextual references for the unique bean that matches the required type and required qualifiers and is eligible for injection into the class into which the parent Instance was injected, or throws an UnsatisfiedResolutionException or AmbiguousResolutionException. 

     PaymentProcessor pp = chequePaymentProcessor.get();

    The inherited Iterable.iterator() method returns an iterator over contextual references for beans that match the required type and required qualifiers and are eligible for injection into the class into which the parent Instance was injected. 

     for (PaymentProcessor pp : anyPaymentProcessor)
     pp.test();
    Author:
    Gavin King
    See Also:
    Provider.get(), Iterable.iterator(), AnnotationLiteral, TypeLiteral

    • Method Detail

      • select

        Instance<T> select(Annotation... qualifiers)

        Obtains a child Instance for the given additional required qualifiers.

        Parameters:
        qualifiers - the additional required qualifiers
        Returns:
        the child Instance
        Throws:
        IllegalArgumentException - if passed two instances of the same qualifier type, or an instance of an annotation that is not a qualifier type

      • select

        <U extends T> Instance<U> select(Class<U> subtype,
                                 Annotation... qualifiers)

        Obtains a child Instance for the given required type and additional required qualifiers.

        Type Parameters:
        U - the required type
        Parameters:
        subtype - a Class representing the required type
        qualifiers - the additional required qualifiers
        Returns:
        the child Instance
        Throws:
        IllegalArgumentException - if passed two instances of the same qualifier type, or an instance of an annotation that is not a qualifier type

      • select

        <U extends T> Instance<U> select(TypeLiteral<U> subtype,
                                 Annotation... qualifiers)

        Obtains a child Instance for the given required type and additional required qualifiers.

        Type Parameters:
        U - the required type
        Parameters:
        subtype - a TypeLiteral representing the required type
        qualifiers - the additional required qualifiers
        Returns:
        the child Instance
        Throws:
        IllegalArgumentException - if passed two instances of the same qualifier type, or an instance of an annotation that is not a qualifier type

      • isUnsatisfied

        boolean isUnsatisfied()

        Determines if there is no bean that matches the required type and qualifiers and is eligible for injection into the class into which the parent Instance was injected.

        Returns:
        true if there is no bean that matches the required type and qualifiers and is eligible for injection into the class into which the parent Instance was injected, or false otherwise.

      • isAmbiguous

        boolean isAmbiguous()

        Determines if there is more than one bean that matches the required type and qualifiers and is eligible for injection into the class into which the parent Instance was injected.

        Returns:
        true if there is more than one bean that matches the required type and qualifiers and is eligible for injection into the class into which the parent Instance was injected, or false otherwise.

      • destroy

        void destroy(T instance)

        On destroy(Object) being called, the container destroys the instance if the active context object for the scope type of the bean supports destroying bean instances. All normal scoped built-in contexts support destroying bean instances.

        The instance passed should either be a dependent scoped bean instance, or the client proxy for a normal scoped bean instance.

        Parameters:
        instance - the instance to destroy
        Throws:
        UnsupportedOperationException - if the active context object for the scope type of the bean does not support destroying bean instances
        Since:
        1.1

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/enterprise/inject/Instance.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, Instance (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.