Class InjectionPoint

java.lang.Object
com.google.inject.spi.InjectionPoint

public final class InjectionPoint extends Object
A constructor, field or method that can receive injections. Typically this is a member with the @Inject annotation. For non-private, no argument constructors, the member may omit the annotation.
Since:
2.0
Author:
crazybob@google.com (Bob Lee)
  • Method Details

    • getMember

      public Member getMember()
      Returns the injected constructor, field, or method.
    • getDependencies

      public List<Dependency<?>> getDependencies()
      Returns the dependencies for this injection point. If the injection point is for a method or constructor, the dependencies will correspond to that member's parameters. Field injection points always have a single dependency for the field itself.
      Returns:
      a possibly-empty list
    • isOptional

      public boolean isOptional()
      Returns true if this injection point shall be skipped if the injector cannot resolve bindings for all required dependencies. Both explicit bindings (as specified in a module), and implicit bindings (@ImplementedBy, default constructors etc.) may be used to satisfy optional injection points.
    • isToolable

      public boolean isToolable()
      Returns true if the element is annotated with @Toolable.
      Since:
      3.0
    • getDeclaringType

      public TypeLiteral<?> getDeclaringType()
      Returns the generic type that defines this injection point. If the member exists on a parameterized type, the result will include more type information than the member's raw declaring class.
      Since:
      3.0
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • forConstructor

      public static <T> InjectionPoint forConstructor(Constructor<T> constructor)
      Returns a new injection point for the specified constructor. If the declaring type of constructor is parameterized (such as List<T>), prefer the overload that includes a type literal.
      Parameters:
      constructor - any single constructor present on type.
      Since:
      3.0
    • forConstructor

      public static <T> InjectionPoint forConstructor(Constructor<T> constructor, TypeLiteral<? extends T> type)
      Returns a new injection point for the specified constructor of type.
      Parameters:
      constructor - any single constructor present on type.
      type - the concrete type that defines constructor.
      Since:
      3.0
    • forConstructorOf

      public static InjectionPoint forConstructorOf(TypeLiteral<?> type)
      Returns a new injection point for the injectable constructor of type.

      Either a @Inject annotated constructor or a non-private no arg constructor is required to be defined by the class corresponding to type.

      Parameters:
      type - a concrete type with exactly one constructor annotated @Inject, or a no-arguments constructor that is not private.
      Throws:
      ConfigurationException - if there is no injectable constructor, more than one injectable constructor, or if parameters of the injectable constructor are malformed, such as a parameter with multiple binding annotations.
    • forConstructorOf

      public static InjectionPoint forConstructorOf(TypeLiteral<?> type, boolean atInjectRequired)
      Returns a new injection point for the injectable constructor of type.

      If atInjectRequired is true, the constructor must be annotated with @Inject. If atInjectRequired is false, either a @Inject annotated constructor or a non-private no arg constructor is required to be defined by the class corresponding to type.

      Parameters:
      type - a concrete type with exactly one constructor annotated @Inject, or a no-arguments constructor that is not private.
      atInjectRequired - whether the constructor must be annotated with Inject.
      Throws:
      ConfigurationException - if there is no injectable constructor, more than one injectable constructor, or if parameters of the injectable constructor are malformed, such as a parameter with multiple binding annotations.
      Since:
      5.0
    • forConstructorOf

      public static InjectionPoint forConstructorOf(Class<?> type)
      Returns a new injection point for the injectable constructor of type.
      Parameters:
      type - a concrete type with exactly one constructor annotated @Inject, or a no-arguments constructor that is not private.
      Throws:
      ConfigurationException - if there is no injectable constructor, more than one injectable constructor, or if parameters of the injectable constructor are malformed, such as a parameter with multiple binding annotations.
    • forMethod

      public static <T> InjectionPoint forMethod(Method method, TypeLiteral<T> type)
      Returns a new injection point for the specified method of type. This is useful for extensions that need to build dependency graphs from arbitrary methods.
      Parameters:
      method - any single method present on type.
      type - the concrete type that defines method.
      Since:
      4.0
    • forStaticMethodsAndFields

      public static Set<InjectionPoint> forStaticMethodsAndFields(TypeLiteral<?> type)
      Returns all static method and field injection points on type.
      Returns:
      a possibly empty set of injection points. The set has a specified iteration order. All fields are returned and then all methods. Within the fields, supertype fields are returned before subtype fields. Similarly, supertype methods are returned before subtype methods.
      Throws:
      ConfigurationException - if there is a malformed injection point on type, such as a field with multiple binding annotations. The exception's partial value is a Set<InjectionPoint> of the valid injection points.
    • forStaticMethodsAndFields

      public static Set<InjectionPoint> forStaticMethodsAndFields(Class<?> type)
      Returns all static method and field injection points on type.
      Returns:
      a possibly empty set of injection points. The set has a specified iteration order. All fields are returned and then all methods. Within the fields, supertype fields are returned before subtype fields. Similarly, supertype methods are returned before subtype methods.
      Throws:
      ConfigurationException - if there is a malformed injection point on type, such as a field with multiple binding annotations. The exception's partial value is a Set<InjectionPoint> of the valid injection points.
    • forInstanceMethodsAndFields

      public static Set<InjectionPoint> forInstanceMethodsAndFields(TypeLiteral<?> type)
      Returns all instance method and field injection points on type.
      Returns:
      a possibly empty set of injection points. The set has a specified iteration order. All fields are returned and then all methods. Within the fields, supertype fields are returned before subtype fields. Similarly, supertype methods are returned before subtype methods.
      Throws:
      ConfigurationException - if there is a malformed injection point on type, such as a field with multiple binding annotations. The exception's partial value is a Set<InjectionPoint> of the valid injection points.
    • forInstanceMethodsAndFields

      public static Set<InjectionPoint> forInstanceMethodsAndFields(Class<?> type)
      Returns all instance method and field injection points on type.
      Returns:
      a possibly empty set of injection points. The set has a specified iteration order. All fields are returned and then all methods. Within the fields, supertype fields are returned before subtype fields. Similarly, supertype methods are returned before subtype methods.
      Throws:
      ConfigurationException - if there is a malformed injection point on type, such as a field with multiple binding annotations. The exception's partial value is a Set<InjectionPoint> of the valid injection points.
    • getAnnotations

      public static Annotation[] getAnnotations(Field field)
      Returns all the annotations on a field. If Kotlin-support is enabled, the annotations will include annotations on the related Kotlin-property.
      Since:
      5.0