Package io.quarkus.arc.lookup

Annotation Interface LookupUnlessProperty

@Repeatable(List.class) @Retention(RUNTIME) @Target({METHOD,TYPE,FIELD}) public @interface LookupUnlessProperty
Indicates that a bean should only be obtained by programmatic lookup if the property does not match the provided value.

This annotation is repeatable and may be put on a stereotype. A bean will be included if all the conditions defined by the LookupUnlessProperty and LookupIfProperty annotations are satisfied. 

 
  interface Service {
     String name();
  }

  @LookupUnlessProperty(name = "service.foo.disabled", stringValue = "true")
  @ApplicationScoped
  class ServiceFoo implements Service {

     public String name() {
        return "foo";
     }
  }

  @ApplicationScoped
  class ServiceBar implements Service {

     public String name() {
        return "bar";
     }
  }

  @ApplicationScoped
  class Client {

     @Inject
     Instance<Service> service;

     void printServiceName() {
        // This would print "bar" if the property of name "service.foo.disabled" is set to true
        // Note that service.get() would normally result in AmbiguousResolutionException
        System.out.println(service.get().name());
     }
  }
See Also:
  • Instance

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    LookupUnlessProperty.List
     

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    Name of the runtime property to check.
    String
    stringValue
    Expected String value of the runtime property (specified by name) if the bean should NOT be looked up at runtime.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    lookupIfMissing
    Determines if the bean should be looked up when the property specified by name has not been specified at all.
    StringValueMatch
    match
    Defines how the stringValue is matched against the actual property value.

  • Element Details

    • name

      String name
      Name of the runtime property to check.

    • stringValue

      String stringValue
      Expected String value of the runtime property (specified by name) if the bean should NOT be looked up at runtime.

    • lookupIfMissing

      boolean lookupIfMissing
      Determines if the bean should be looked up when the property specified by name has not been specified at all.
      Default:
      false

    • match

      StringValueMatch match
      Defines how the stringValue is matched against the actual property value.

      By default, exact string equality (StringValueMatch.EQ) is used. Set to StringValueMatch.REGEX to interpret stringValue as a regular expression.

      Default:
      EQ