Module io.helidon.inject.api
Package io.helidon.inject.api

Interface InjectionPointInfo

All Superinterfaces:
ElementInfo, Prototype.Api
All Known Implementing Classes:
InjectionPointInfo.BuilderBase.InjectionPointInfoImpl
public interface InjectionPointInfo extends Prototype.Api, ElementInfo
Deprecated.
Helidon inject is deprecated and will be replaced in a future version
Describes a receiver for injection - identifies who/what is requesting an injection that needs to be satisfied.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    InjectionPointInfo.Builder
    Deprecated.
    Fluent API builder for InjectionPointInfo.
    static class 
    InjectionPointInfo.BuilderBase<BUILDER extends InjectionPointInfo.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends InjectionPointInfo>
    Deprecated.
    Fluent API builder base for InjectionPointInfo.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CONSTRUCTOR
    Deprecated, for removal: This API element is subject to removal in a future version.
    The name assigned to constructors.

  • Method Summary

    Modifier and Type
    Method
    Description
    AccessModifier
    access()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The access modifier on the injection point/receiver.
    Set<Annotation>
    annotations()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The annotations on this element.
    String
    baseIdentity()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The base identifying name for this injection point.
    static InjectionPointInfo.Builder
    builder()
    Deprecated.
    Create a new fluent API builder to customize configuration.
    static InjectionPointInfo.Builder
    builder(InjectionPointInfo instance)
    Deprecated.
    Create a new fluent API builder from an existing instance.
    static InjectionPointInfo
    create()
    Deprecated.
    Create a new instance with default values.
    ServiceInfoCriteria
    dependencyToServiceInfo()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The service info criteria/dependency this is dependent upon.
    Optional<Integer>
    elementArgs()
    Deprecated, for removal: This API element is subject to removal in a future version.
    If the element is a method or constructor then this is the total argument count for that method.
    ElementKind
    elementKind()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The injection point/receiver kind.
    String
    elementName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The element name (e.g., method name or field name).
    Optional<Integer>
    elementOffset()
    Deprecated, for removal: This API element is subject to removal in a future version.
    If the element is a method or constructor then this is the ordinal argument position of that argument.
    TypeName
    elementTypeName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The element type name (e.g., method type or field type).
    String
    id()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The identity (aka id) for this injection point.
    String
    ipName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Name of the field or argument we are injecting into.
    TypeName
    ipType()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Type of the field or argument we are injecting into.
    boolean
    listWrapped()
    Deprecated, for removal: This API element is subject to removal in a future version.
    True if the injection point is of type List.
    boolean
    optionalWrapped()
    Deprecated, for removal: This API element is subject to removal in a future version.
    True if the injection point is of type Optional.
    boolean
    providerWrapped()
    Deprecated, for removal: This API element is subject to removal in a future version.
    True if the injection point is of type Provider (or Supplier).
    Set<Qualifier>
    qualifiers()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The qualifier type annotations on this element.
    TypeName
    serviceTypeName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The enclosing class name for the element.
    boolean
    staticDeclaration()
    Deprecated, for removal: This API element is subject to removal in a future version.
    True if the injection point is static.

  • Field Details

    • CONSTRUCTOR

      static final String CONSTRUCTOR
      Deprecated, for removal: This API element is subject to removal in a future version.
      The name assigned to constructors.
      See Also:

  • Method Details

    • builder

      static InjectionPointInfo.Builder builder()
      Deprecated.
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder

    • builder

      static InjectionPointInfo.Builder builder(InjectionPointInfo instance)
      Deprecated.
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance

    • create

      static InjectionPointInfo create()
      Deprecated.
      Create a new instance with default values.
      Returns:
      a new instance

    • ipName

      String ipName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Name of the field or argument we are injecting into. Best effort, if cannot be found, an indexed approach may be used (such as arg0).
      Returns:
      name of the injection point field or argument

    • ipType

      TypeName ipType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Type of the field or argument we are injecting into.
      Returns:
      type of the field or argument, including generic type declarations

    • id

      String id()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The identity (aka id) for this injection point. The id should be unique for the service type it is contained within.

      This method will return the baseIdentity() when elementOffset() is null. If not null then the elemOffset is part of the returned identity.

      Returns:
      the unique identity

    • baseIdentity

      String baseIdentity()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The base identifying name for this injection point. If the element represents a function, then the function arguments are encoded in its base identity.
      Returns:
      the base identity of the element

    • listWrapped

      boolean listWrapped()
      Deprecated, for removal: This API element is subject to removal in a future version.
      True if the injection point is of type List.
      Returns:
      true if list based receiver

    • optionalWrapped

      boolean optionalWrapped()
      Deprecated, for removal: This API element is subject to removal in a future version.
      True if the injection point is of type Optional.
      Returns:
      true if optional based receiver

    • providerWrapped

      boolean providerWrapped()
      Deprecated, for removal: This API element is subject to removal in a future version.
      True if the injection point is of type Provider (or Supplier).
      Returns:
      true if provider based receiver

    • dependencyToServiceInfo

      ServiceInfoCriteria dependencyToServiceInfo()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The service info criteria/dependency this is dependent upon.
      Returns:
      the service info criteria we are dependent upon

    • elementKind

      ElementKind elementKind()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The injection point/receiver kind.
      Returns:
      the kind

    • access

      AccessModifier access()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The access modifier on the injection point/receiver.
      Returns:
      the access

    • elementTypeName

      TypeName elementTypeName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The element type name (e.g., method type or field type).
      Returns:
      the target receiver type name

    • elementName

      String elementName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The element name (e.g., method name or field name).
      Returns:
      the target receiver name

    • elementOffset

      Optional<Integer> elementOffset()
      Deprecated, for removal: This API element is subject to removal in a future version.
      If the element is a method or constructor then this is the ordinal argument position of that argument.
      Returns:
      the offset argument, 0 based, or empty if field type

    • elementArgs

      Optional<Integer> elementArgs()
      Deprecated, for removal: This API element is subject to removal in a future version.
      If the element is a method or constructor then this is the total argument count for that method.
      Returns:
      total argument count

    • staticDeclaration

      boolean staticDeclaration()
      Deprecated, for removal: This API element is subject to removal in a future version.
      True if the injection point is static.
      Returns:
      true if static receiver

    • serviceTypeName

      TypeName serviceTypeName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The enclosing class name for the element.
      Returns:
      service type name

    • annotations

      Set<Annotation> annotations()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The annotations on this element.
      Returns:
      the annotations on this element

    • qualifiers

      Set<Qualifier> qualifiers()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The qualifier type annotations on this element.
      Returns:
      the qualifier type annotations on this element