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

Interface ServiceInfoCriteria

All Superinterfaces:
Prototype.Api
All Known Implementing Classes:
ServiceInfoCriteria.BuilderBase.ServiceInfoCriteriaImpl
public interface ServiceInfoCriteria extends Prototype.Api
Deprecated.
Helidon inject is deprecated and will be replaced in a future version
Criteria to discover services.
See Also:

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<TypeName>
    activatorTypeName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The management agent (i.e., the activator) that is responsible for creating and activating - typically build-time created.
    static ServiceInfoCriteria.Builder
    builder()
    Deprecated.
    Create a new fluent API builder to customize configuration.
    static ServiceInfoCriteria.Builder
    builder(ServiceInfoCriteria instance)
    Deprecated.
    Create a new fluent API builder from an existing instance.
    Set<TypeName>
    contractsImplemented()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The managed services advertised types (i.e., typically its interfaces).
    static ServiceInfoCriteria
    create()
    Deprecated.
    Create a new instance with default values.
    Set<TypeName>
    externalContractsImplemented()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The managed services external contracts / interfaces.
    boolean
    includeIntercepted()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Determines whether the non-proxied, Intercepted services should be returned in any lookup operation.
    default boolean
    matches(io.helidon.inject.api.ServiceInfoCriteriaBlueprint criteria)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Determines whether this service info matches the criteria for injection.
    default boolean
    matchesContracts(io.helidon.inject.api.ServiceInfoCriteriaBlueprint criteria)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Determines whether the provided criteria match just the contracts portion of the provided criteria.
    Optional<String>
    moduleName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The name of the ascribed module, if known.
    Set<Qualifier>
    qualifiers()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The managed service assigned Qualifier's.
    Optional<Integer>
    runLevel()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The optional RunLevel ascribed to the service.
    Set<TypeName>
    scopeTypeNames()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The managed service assigned Scope's.
    Optional<TypeName>
    serviceTypeName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The managed service implementation type name.
    Optional<Double>
    weight()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Weight that was declared on the type itself.

  • Method Details

    • builder

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

    • builder

      static ServiceInfoCriteria.Builder builder(ServiceInfoCriteria 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 ServiceInfoCriteria create()
      Deprecated.
      Create a new instance with default values.
      Returns:
      a new instance

    • serviceTypeName

      Optional<TypeName> serviceTypeName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The managed service implementation type name.
      Returns:
      the service type name

    • scopeTypeNames

      Set<TypeName> scopeTypeNames()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The managed service assigned Scope's.
      Returns:
      the service scope type name

    • qualifiers

      Set<Qualifier> qualifiers()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The managed service assigned Qualifier's.
      Returns:
      the service qualifiers

    • contractsImplemented

      Set<TypeName> contractsImplemented()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The managed services advertised types (i.e., typically its interfaces).
      Returns:
      the service contracts implemented
      See Also:

    • runLevel

      Optional<Integer> runLevel()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The optional RunLevel ascribed to the service.
      Returns:
      the service's run level

    • weight

      Optional<Double> weight()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Weight that was declared on the type itself.
      Returns:
      the declared weight

    • externalContractsImplemented

      Set<TypeName> externalContractsImplemented()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The managed services external contracts / interfaces. These should also be contained within contractsImplemented(). External contracts are from other modules other than the module containing the implementation typically.
      Returns:
      the service external contracts implemented
      See Also:

    • activatorTypeName

      Optional<TypeName> activatorTypeName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The management agent (i.e., the activator) that is responsible for creating and activating - typically build-time created.
      Returns:
      the activator type name

    • moduleName

      Optional<String> moduleName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The name of the ascribed module, if known.
      Returns:
      the module name

    • includeIntercepted

      boolean includeIntercepted()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Determines whether the non-proxied, Intercepted services should be returned in any lookup operation. If this option is disabled then only the Interceptor-generated service will be eligible to be returned and not the service being intercepted. The default value is false.
      Returns:
      true if the non-proxied type intercepted services should be eligible

    • matches

      default boolean matches(io.helidon.inject.api.ServiceInfoCriteriaBlueprint criteria)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Determines whether this service info matches the criteria for injection. Matches is a looser form of equality check than equals(). If a service matches criteria it is generally assumed to be viable for assignability.
      Parameters:
      criteria - the criteria to compare against
      Returns:
      true if the criteria provided matches this instance

    • matchesContracts

      default boolean matchesContracts(io.helidon.inject.api.ServiceInfoCriteriaBlueprint criteria)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Determines whether the provided criteria match just the contracts portion of the provided criteria. Note that it is expected any external contracts have been consolidated into the regular contract section.
      Parameters:
      criteria - the criteria to compare against
      Returns:
      true if the criteria provided matches this instance from only the contracts point of view