Close

Spring - Java 8 functions support in ObjectProvider to provide callbacks

[Last Updated: Jun 11, 2021]

Spring 5.0 added following new methods in ObjectProvider interface which support java.util.function callbacks:


default T getIfAvailable(java.util.function.Supplier<T> defaultSupplier) throws BeansException

The defaultSupplier parameter is a callback for supplying a default object if none is present in the container.


default void ifAvailable(java.util.function.Consumer<T> dependencyConsumer)  throws BeansException

The dependencyConsumer parameter is a callback for processing the target object if available (not called otherwise).


default T getIfUnique(java.util.function.Supplier<T> defaultSupplier)  throws BeansException

The defaultSupplier parameter is a callback for supplying a default object if no unique candidate is present in the container


default void ifUnique(java.util.function.Consumer<T> dependencyConsumer)  throws BeansException

The dependencyConsumer parameter is a callback for processing the target object if unique (not called otherwise).


Examples

Example Bean

public class MsgBean {
  private String msg;

  public MsgBean(String msg) {
      this.msg = msg;
  }

  public void showMessage() {
      System.out.println("msg: " + msg);
  }
}

getIfAvailable(defaultSupplier) example

@Configuration
public class GetIfAvailableWithSupplier {
  //uncomment @Bean then getIfAvailable will return this instance
  //@Bean
  MsgBean msgBean() {
      return new MsgBean("test msg");
  }

  public static void main(String[] args) {
      AnnotationConfigApplicationContext context =
              new AnnotationConfigApplicationContext(GetIfAvailableWithSupplier.class);
      ObjectProvider<MsgBean> beanProvider = context.getBeanProvider(MsgBean.class);
      MsgBean exampleBean = beanProvider.getIfAvailable(() -> new MsgBean("default msg"));
      exampleBean.showMessage();
  }
}

Output

msg: default msg

ifAvailable(defaultConsumer) example

@Configuration
public class IfAvailableWithConsumer {
  //remove @Bean annotation then getIfAvailable will print nothing
  @Bean
  MsgBean msgBean() {
      return new MsgBean("test msg");
  }

  public static void main(String[] args) {
      AnnotationConfigApplicationContext context =
              new AnnotationConfigApplicationContext(IfAvailableWithConsumer.class);
      ObjectProvider<MsgBean> beanProvider = context.getBeanProvider(MsgBean.class);
      beanProvider.ifAvailable(msgBean -> msgBean.showMessage());
  }
}

Output

msg: test msg

getIfUnique(defaultSupplier) example

@Configuration
public class GetIfUniqueWithSupplier {
  @Bean
  MsgBean msgBean() {
      return new MsgBean("test msg 1");
  }

  //if we remove @Bean here, then 'test msg 1' will print
  @Bean
  MsgBean msgBean2() {
      return new MsgBean("test msg 2");
  }

  public static void main(String[] args) {
      AnnotationConfigApplicationContext context =
              new AnnotationConfigApplicationContext(GetIfUniqueWithSupplier.class);
      ObjectProvider<MsgBean> beanProvider = context.getBeanProvider(MsgBean.class);
      MsgBean exampleBean = beanProvider.getIfUnique(() -> new MsgBean("default msg"));
      exampleBean.showMessage();
  }
}

Output

msg: default msg

ifUnique(dependencyConsumer) example

@Configuration
public class IfUniqueWithConsumer {
  @Bean
  MsgBean msgBean() {
      return new MsgBean("test msg 1");
  }

  //if uncomment @Bean annotation here, then nothing will print
  //@Bean
  MsgBean msgBean2() {
      return new MsgBean("test msg 2");
  }

  public static void main(String[] args) {
      AnnotationConfigApplicationContext context =
              new AnnotationConfigApplicationContext(IfUniqueWithConsumer.class);
      ObjectProvider<MsgBean> beanProvider = context.getBeanProvider(MsgBean.class);
      beanProvider.ifUnique(msgBean -> msgBean.showMessage());
  }
}

Output

msg: test msg 1

Example Project

Dependencies and Technologies Used:

  • spring-context 5.3.8: Spring Context. Version Compatibility: 5.1.0.RELEASE - 5.3.8 Version List
    ×

    Version compatibilities of spring-context with this example:

    • 5.1.0.RELEASE
    • 5.1.1.RELEASE
    • 5.1.2.RELEASE
    • 5.1.3.RELEASE
    • 5.1.4.RELEASE
    • 5.1.5.RELEASE
    • 5.1.6.RELEASE
    • 5.1.7.RELEASE
    • 5.1.8.RELEASE
    • 5.1.9.RELEASE
    • 5.1.10.RELEASE
    • 5.1.11.RELEASE
    • 5.1.12.RELEASE
    • 5.1.13.RELEASE
    • 5.1.14.RELEASE
    • 5.1.15.RELEASE
    • 5.1.16.RELEASE
    • 5.1.17.RELEASE
    • 5.1.18.RELEASE
    • 5.1.19.RELEASE
    • 5.1.20.RELEASE
    • 5.2.0.RELEASE
    • 5.2.1.RELEASE
    • 5.2.2.RELEASE
    • 5.2.3.RELEASE
    • 5.2.4.RELEASE
    • 5.2.5.RELEASE
    • 5.2.6.RELEASE
    • 5.2.7.RELEASE
    • 5.2.8.RELEASE
    • 5.2.9.RELEASE
    • 5.2.10.RELEASE
    • 5.2.11.RELEASE
    • 5.2.12.RELEASE
    • 5.2.13.RELEASE
    • 5.2.14.RELEASE
    • 5.2.15.RELEASE
    • 5.3.0
    • 5.3.1
    • 5.3.2
    • 5.3.3
    • 5.3.4
    • 5.3.5
    • 5.3.6
    • 5.3.7
    • 5.3.8

    Versions in green have been tested.

  • JDK 8
  • Maven 3.8.1

Spring 5.0 new ObjectProvider methods Select All Download
  • spring-object-provider-function-callbacks
    • src
      • main
        • java
          • com
            • logicbig
              • example
                • GetIfAvailableWithSupplier.java

    See Also