Package jakarta.enterprise.inject.spi

Interface InjectionPoint

public interface InjectionPoint

Provides access to metadata about an injection point. May represent an injected field or a parameter of a bean constructor, initializer method, producer method, disposer method or observer method. If the injection point does not belong to a bean or belongs to a synthetic bean, some methods may return null.

If the injection point is a dynamically obtained instance, then the required type and required qualifiers are defined by the Instance and other metadata reflect the injection point of the Instance. If the Instance is not injected, some methods may return null.

Occasionally, a bean with scope @Dependent needs to access metadata relating to the object to which it belongs. The bean may inject an InjectionPoint representing the injection point into which the bean was injected.

For example, the following producer method creates injectable Loggers. The log category of a Logger depends upon the class of the object into which it is injected. 

 @Produces
 Logger createLogger(InjectionPoint injectionPoint) {
     return Logger.getLogger(injectionPoint.getMember().getDeclaringClass().getName());
 }

Only dependent objects may obtain information about the injection point to which they belong.

Author:
Gavin King, Pete Muir

  • Method Details

    • getType

      Type getType()
      Returns the required type of injection point.
      Returns:
      the required type, never null

    • getQualifiers

      Set<Annotation> getQualifiers()
      Returns the required qualifiers of the injection point.
      Returns:
      the required qualifiers, never null

    • getBean

      Bean<?> getBean()
      Returns the Bean that defines the injection point.

      If the injection point belongs to a synthetic bean, may return null. If the injection point does not belong to a bean or belongs to a dynamically obtained instance where the Instance is not injected, returns null.

      Returns:
      the bean that defines the injection point, may be null

    • getMember

      Member getMember()
      Returns the Field in the case of field injection, the Method in the case of method parameter injection, or the Constructor in the case of constructor parameter injection.

      If the injection point belongs to a synthetic bean, may return null. If the injection point belongs to a dynamically obtained instance where the Instance is not injected, returns null.

      Returns:
      the member, may be null

    • getAnnotated

      Annotated getAnnotated()
      Returns an AnnotatedField or AnnotatedParameter, depending on whether the injection point is a field or a constructor/method parameter.

      If the injection point belongs to a synthetic bean, may return null. If the injection point belongs to a dynamically obtained instance where the Instance is not injected, returns null.

      May always return null when the container only supports CDI Lite.

      Returns:
      the annotated member, may be null

    • isDelegate

      boolean isDelegate()
      Returns whether the injection point is a decorator @Delegate injection point.
      Returns:
      true if the injection point is a decorator delegate injection point, and false otherwise

    • isTransient

      boolean isTransient()
      Returns whether the getMember() method returns a Field which is declared transient.
      Returns:
      true if the injection point is a transient field, and false otherwise