Package org.apache.commons.lang3.concurrent

Class MultiBackgroundInitializer.MultiBackgroundInitializerResults

  • Enclosing class:
    MultiBackgroundInitializer
    public static class MultiBackgroundInitializer.MultiBackgroundInitializerResults
extends java.lang.Object
    A data class for storing the results of the background initialization performed by MultiBackgroundInitializer. Objects of this inner class are returned by MultiBackgroundInitializer.initialize(). They allow access to all result objects produced by the BackgroundInitializer objects managed by the owning instance. It is also possible to retrieve status information about single BackgroundInitializers, i.e. whether they completed normally or caused an exception.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Map<java.lang.String,​ConcurrentException> exceptions
      A map with the exceptions.
      private java.util.Map<java.lang.String,​BackgroundInitializer<?>> initializers
      A map with the child initializers.
      private java.util.Map<java.lang.String,​java.lang.Object> resultObjects
      A map with the result objects.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private MultiBackgroundInitializerResults​(java.util.Map<java.lang.String,​BackgroundInitializer<?>> inits, java.util.Map<java.lang.String,​java.lang.Object> results, java.util.Map<java.lang.String,​ConcurrentException> excepts)
      Creates a new instance of MultiBackgroundInitializerResults and initializes it with maps for the BackgroundInitializer objects, their result objects and the exceptions thrown by them.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private BackgroundInitializer<?> checkName​(java.lang.String name)
      Checks whether an initializer with the given name exists.
      ConcurrentException getException​(java.lang.String name)
      Returns the ConcurrentException object that was thrown by the BackgroundInitializer with the given name.
      BackgroundInitializer<?> getInitializer​(java.lang.String name)
      Returns the BackgroundInitializer with the given name.
      java.lang.Object getResultObject​(java.lang.String name)
      Returns the result object produced by the BackgroundInitializer with the given name.
      java.util.Set<java.lang.String> initializerNames()
      Returns a set with the names of all BackgroundInitializer objects managed by the MultiBackgroundInitializer.
      boolean isException​(java.lang.String name)
      Returns a flag whether the BackgroundInitializer with the given name caused an exception.
      boolean isSuccessful()
      Returns a flag whether the whole initialization was successful.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • initializers

        private final java.util.Map<java.lang.String,​BackgroundInitializer<?>> initializers
        A map with the child initializers.

      • resultObjects

        private final java.util.Map<java.lang.String,​java.lang.Object> resultObjects
        A map with the result objects.

      • exceptions

        private final java.util.Map<java.lang.String,​ConcurrentException> exceptions
        A map with the exceptions.

    • Constructor Detail

      • MultiBackgroundInitializerResults

        private MultiBackgroundInitializerResults​(java.util.Map<java.lang.String,​BackgroundInitializer<?>> inits,
                                          java.util.Map<java.lang.String,​java.lang.Object> results,
                                          java.util.Map<java.lang.String,​ConcurrentException> excepts)
        Creates a new instance of MultiBackgroundInitializerResults and initializes it with maps for the BackgroundInitializer objects, their result objects and the exceptions thrown by them.
        Parameters:
        inits - the BackgroundInitializer objects
        results - the result objects
        excepts - the exceptions

    • Method Detail

      • getInitializer

        public BackgroundInitializer<?> getInitializer​(java.lang.String name)
        Returns the BackgroundInitializer with the given name. If the name cannot be resolved, an exception is thrown.
        Parameters:
        name - the name of the BackgroundInitializer
        Returns:
        the BackgroundInitializer with this name
        Throws:
        java.util.NoSuchElementException - if the name cannot be resolved

      • getResultObject

        public java.lang.Object getResultObject​(java.lang.String name)
        Returns the result object produced by the BackgroundInitializer with the given name. This is the object returned by the initializer's initialize() method. If this BackgroundInitializer caused an exception, null is returned. If the name cannot be resolved, an exception is thrown.
        Parameters:
        name - the name of the BackgroundInitializer
        Returns:
        the result object produced by this BackgroundInitializer
        Throws:
        java.util.NoSuchElementException - if the name cannot be resolved

      • isException

        public boolean isException​(java.lang.String name)
        Returns a flag whether the BackgroundInitializer with the given name caused an exception.
        Parameters:
        name - the name of the BackgroundInitializer
        Returns:
        a flag whether this initializer caused an exception
        Throws:
        java.util.NoSuchElementException - if the name cannot be resolved

      • getException

        public ConcurrentException getException​(java.lang.String name)
        Returns the ConcurrentException object that was thrown by the BackgroundInitializer with the given name. If this initializer did not throw an exception, the return value is null. If the name cannot be resolved, an exception is thrown.
        Parameters:
        name - the name of the BackgroundInitializer
        Returns:
        the exception thrown by this initializer
        Throws:
        java.util.NoSuchElementException - if the name cannot be resolved

      • initializerNames

        public java.util.Set<java.lang.String> initializerNames()
        Returns a set with the names of all BackgroundInitializer objects managed by the MultiBackgroundInitializer.
        Returns:
        an (unmodifiable) set with the names of the managed BackgroundInitializer objects

      • isSuccessful

        public boolean isSuccessful()
        Returns a flag whether the whole initialization was successful. This is the case if no child initializer has thrown an exception.
        Returns:
        a flag whether the initialization was successful

      • checkName

        private BackgroundInitializer<?> checkName​(java.lang.String name)
        Checks whether an initializer with the given name exists. If not, throws an exception. If it exists, the associated child initializer is returned.
        Parameters:
        name - the name to check
        Returns:
        the initializer with this name
        Throws:
        java.util.NoSuchElementException - if the name is unknown