Package io.quarkus.arc.deployment

Class SyntheticBeanBuildItem.ExtendedBeanConfigurator

java.lang.Object
io.quarkus.arc.processor.ConfiguratorBase<SyntheticBeanBuildItem.ExtendedBeanConfigurator>
io.quarkus.arc.processor.BeanConfiguratorBase<SyntheticBeanBuildItem.ExtendedBeanConfigurator,Object>
io.quarkus.arc.deployment.SyntheticBeanBuildItem.ExtendedBeanConfigurator
All Implemented Interfaces:
Consumer<org.jboss.jandex.AnnotationInstance>
Enclosing class:
SyntheticBeanBuildItem
public static class SyntheticBeanBuildItem.ExtendedBeanConfigurator extends io.quarkus.arc.processor.BeanConfiguratorBase<SyntheticBeanBuildItem.ExtendedBeanConfigurator,Object>
This construct is not thread-safe and should not be reused.

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.quarkus.arc.processor.BeanConfiguratorBase

    io.quarkus.arc.processor.BeanConfiguratorBase.CheckActiveGeneration, io.quarkus.arc.processor.BeanConfiguratorBase.CreateGeneration, io.quarkus.arc.processor.BeanConfiguratorBase.DestroyGeneration

  • Field Summary

    Fields inherited from class io.quarkus.arc.processor.BeanConfiguratorBase

    alternative, checkActiveConsumer, creatorConsumer, defaultBean, destroyerConsumer, forceApplicationClass, identifier, implClazz, injectionPoints, interceptionProxy, name, priority, providerType, qualifiers, registeredTypeClosures, removable, scope, startupPriority, stereotypes, targetPackageName, types, typesToRemove

    Fields inherited from class io.quarkus.arc.processor.ConfiguratorBase

    params

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExtendedBeanConfigurator(org.jboss.jandex.DotName implClazz)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    SyntheticBeanBuildItem.ExtendedBeanConfigurator
    checkActive(Supplier<io.quarkus.arc.ActiveResult> checkActive)
    The BeanConfiguratorBase.checkActive(Consumer) procedure is a Supplier<ActiveResult> proxy returned from a recorder method.
    <B> SyntheticBeanBuildItem.ExtendedBeanConfigurator
    createWith(Function<io.quarkus.arc.SyntheticCreationalContext<B>,B> function)
    The contextual bean instance is created by a proxy returned from a recorder method.
    SyntheticBeanBuildItem
    done()
    Finish the configurator.
    (package private) Supplier<io.quarkus.arc.ActiveResult>
    getCheckActive()
     
    (package private) Function<io.quarkus.arc.SyntheticCreationalContext<?>,?>
    getFunction()
     
    (package private) String
    getIdentifier()
     
    (package private) org.jboss.jandex.DotName
    getImplClazz()
     
    (package private) Set<org.jboss.jandex.AnnotationInstance>
    getQualifiers()
     
    (package private) Object
    getRuntimeProxy()
     
    (package private) io.quarkus.runtime.RuntimeValue<?>
    getRuntimeValue()
     
    (package private) Supplier<?>
    getSupplier()
     
    (package private) Set<org.jboss.jandex.Type>
    getTypes()
     
    SyntheticBeanBuildItem.ExtendedBeanConfigurator
    runtimeProxy(Object proxy)
    The contextual bean instance is a proxy returned from a recorder method.
    SyntheticBeanBuildItem.ExtendedBeanConfigurator
    runtimeValue(io.quarkus.runtime.RuntimeValue<?> runtimeValue)
    The contextual bean instance is a proxy returned from a recorder method.
    SyntheticBeanBuildItem.ExtendedBeanConfigurator
    setRuntimeInit()
    A synthetic bean whose instance is produced through a recorder is initialized during ExecutionTime.STATIC_INIT by default.
    SyntheticBeanBuildItem.ExtendedBeanConfigurator
    supplier(Supplier<?> supplier)
    The contextual bean instance is supplied by a proxy returned from a recorder method.

    Methods inherited from class io.quarkus.arc.processor.BeanConfiguratorBase

    accept, addInjectionPoint, addQualifier, addQualifier, addQualifier, addQualifier, addStereotype, addType, addType, addType, addTypeClosure, addTypeClosure, addTypeClosure, alternative, cast, checkActive, checkActive, creator, creator, defaultBean, destroyer, destroyer, forceApplicationClass, identifier, injectInterceptionProxy, injectInterceptionProxy, injectInterceptionProxy, name, named, priority, providerType, qualifiers, read, removeTypes, removeTypes, removeTypes, scope, scope, startup, startup, stereotypes, targetPackageName, types, types, unremovable

    Methods inherited from class io.quarkus.arc.processor.ConfiguratorBase

    param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, param, read, self

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface java.util.function.Consumer

    andThen

  • Constructor Details

    • ExtendedBeanConfigurator

      ExtendedBeanConfigurator(org.jboss.jandex.DotName implClazz)

  • Method Details

    • done

      public SyntheticBeanBuildItem done()
      Finish the configurator.
      Returns:
      a new build item

    • supplier

      public SyntheticBeanBuildItem.ExtendedBeanConfigurator supplier(Supplier<?> supplier)
      The contextual bean instance is supplied by a proxy returned from a recorder method.

      Use createWith(Function) if you want to leverage build-time parameters or synthetic injection points.

      Parameters:
      supplier - A supplier returned from a recorder method
      Returns:
      self
      Throws:
      IllegalArgumentException - If the supplier argument is not a proxy returned from a recorder method

    • runtimeValue

      public SyntheticBeanBuildItem.ExtendedBeanConfigurator runtimeValue(io.quarkus.runtime.RuntimeValue<?> runtimeValue)
      The contextual bean instance is a proxy returned from a recorder method.

      Use createWith(Function) if you want to leverage build-time parameters or synthetic injection points.

      Parameters:
      runtimeValue - A runtime value returned from a recorder method
      Returns:
      self
      Throws:
      IllegalArgumentException - If the runtimeValue argument is not a proxy returned from a recorder method

    • createWith

      public <B> SyntheticBeanBuildItem.ExtendedBeanConfigurator createWith(Function<io.quarkus.arc.SyntheticCreationalContext<B>,B> function)
      The contextual bean instance is created by a proxy returned from a recorder method.

      This method is useful if you need to use build-time parameters or synthetic injection points during creation of a bean instance.

      Parameters:
      function - A function returned from a recorder method
      Returns:
      self
      Throws:
      IllegalArgumentException - If the function argument is not a proxy returned from a recorder method

    • runtimeProxy

      public SyntheticBeanBuildItem.ExtendedBeanConfigurator runtimeProxy(Object proxy)
      The contextual bean instance is a proxy returned from a recorder method.

      Use createWith(Function) if you want to leverage build-time parameters or synthetic injection points.

      Parameters:
      proxy - A proxy returned from a recorder method
      Returns:
      self
      Throws:
      IllegalArgumentException - If the proxy argument is not a proxy returned from a recorder method

    • setRuntimeInit

      public SyntheticBeanBuildItem.ExtendedBeanConfigurator setRuntimeInit()
      A synthetic bean whose instance is produced through a recorder is initialized during ExecutionTime.STATIC_INIT by default.

      It is possible to change this behavior and initialize the bean during the ExecutionTime.RUNTIME_INIT. However, in such case a client that attempts to obtain such bean during ExecutionTime.STATIC_INIT or before runtime-init synthetic beans are initialized will receive an exception.

      ExecutionTime.RUNTIME_INIT build steps that access a runtime-init synthetic bean should consume the SyntheticBeansRuntimeInitBuildItem.

      Returns:
      self
      See Also:

    • checkActive

      public SyntheticBeanBuildItem.ExtendedBeanConfigurator checkActive(Supplier<io.quarkus.arc.ActiveResult> checkActive)
      The BeanConfiguratorBase.checkActive(Consumer) procedure is a Supplier<ActiveResult> proxy returned from a recorder method.
      Parameters:
      checkActive - a Supplier<ActiveResult> returned from a recorder method
      Returns:
      self
      Throws:
      IllegalArgumentException - if the checkActive argument is not a proxy returned from a recorder method

    • getImplClazz

      org.jboss.jandex.DotName getImplClazz()

    • getTypes

      Set<org.jboss.jandex.Type> getTypes()

    • getQualifiers

      Set<org.jboss.jandex.AnnotationInstance> getQualifiers()

    • getIdentifier

      String getIdentifier()

    • getSupplier

      Supplier<?> getSupplier()

    • getRuntimeValue

      io.quarkus.runtime.RuntimeValue<?> getRuntimeValue()

    • getFunction

      Function<io.quarkus.arc.SyntheticCreationalContext<?>,?> getFunction()

    • getRuntimeProxy

      Object getRuntimeProxy()

    • getCheckActive

      Supplier<io.quarkus.arc.ActiveResult> getCheckActive()