Class MultiBackgroundInitializer.MultiBackgroundInitializerResults
java.lang.Object
org.apache.commons.lang3.concurrent.MultiBackgroundInitializer.MultiBackgroundInitializerResults
- Enclosing class:
MultiBackgroundInitializer
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.-
Method Summary
Modifier and TypeMethodDescriptiongetException(String name) Gets theConcurrentExceptionobject that was thrown by theBackgroundInitializerwith the given name.getInitializer(String name) Gets theBackgroundInitializerwith the given name.getResultObject(String name) Gets the result object produced by theBackgroundInitializerwith the given name.Returns a set with the names of allBackgroundInitializerobjects managed by theMultiBackgroundInitializer.booleanisException(String name) Tests whether theBackgroundInitializerwith the given name caused an exception.booleanTests whether the whole initialization was successful.
-
Method Details
-
getException
Gets theConcurrentExceptionobject that was thrown by theBackgroundInitializerwith 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 theBackgroundInitializer- Returns:
- the exception thrown by this initializer
- Throws:
NoSuchElementException- if the name cannot be resolved
-
getInitializer
Gets theBackgroundInitializerwith the given name. If the name cannot be resolved, an exception is thrown.- Parameters:
name- the name of theBackgroundInitializer- Returns:
- the
BackgroundInitializerwith this name - Throws:
NoSuchElementException- if the name cannot be resolved
-
getResultObject
Gets the result object produced by theBackgroundInitializerwith the given name. This is the object returned by the initializer'sinitialize()method. If thisBackgroundInitializercaused an exception, null is returned. If the name cannot be resolved, an exception is thrown.- Parameters:
name- the name of theBackgroundInitializer- Returns:
- the result object produced by this
BackgroundInitializer - Throws:
NoSuchElementException- if the name cannot be resolved
-
initializerNames
Returns a set with the names of allBackgroundInitializerobjects managed by theMultiBackgroundInitializer.- Returns:
- an (unmodifiable) set with the names of the managed
BackgroundInitializerobjects
-
isException
Tests whether theBackgroundInitializerwith the given name caused an exception.- Parameters:
name- the name of theBackgroundInitializer- Returns:
- a flag whether this initializer caused an exception
- Throws:
NoSuchElementException- if the name cannot be resolved
-
isSuccessful
Tests 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
-