Package org.apache.commons.lang3.concurrent

Class MultiBackgroundInitializer.MultiBackgroundInitializerResults

java.lang.Object

org.apache.commons.lang3.concurrent.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<?>> initializers, java.util.Map<java.lang.String,java.lang.Object> resultObjects, java.util.Map<java.lang.String,ConcurrentException> exceptions)	Creates a new instance of MultiBackgroundInitializer.MultiBackgroundInitializerResults and initializes it with maps for the BackgroundInitializer objects, their result objects and the exceptions thrown by them.

Method Summary

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)	Gets the ConcurrentException object that was thrown by the BackgroundInitializer with the given name.
BackgroundInitializer<?>	getInitializer(java.lang.String name)	Gets the BackgroundInitializer with the given name.
java.lang.Object	getResultObject(java.lang.String name)	Gets 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)	Tests whether the BackgroundInitializer with the given name caused an exception.
boolean	isSuccessful()	Tests 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<?>> initializers,
                                          java.util.Map<java.lang.String,java.lang.Object> resultObjects,
                                          java.util.Map<java.lang.String,ConcurrentException> exceptions)

Creates a new instance of MultiBackgroundInitializer.MultiBackgroundInitializerResults and initializes it with maps for the BackgroundInitializer objects, their result objects and the exceptions thrown by them.

Parameters:

initializers - the BackgroundInitializer objects.

resultObjects - the result objects.

exceptions - the exceptions.

Method Detail

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.

getException

public ConcurrentException getException(java.lang.String name)

Gets 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.

getInitializer

public BackgroundInitializer<?> getInitializer(java.lang.String name)

Gets 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)

Gets 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.

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.

isException

public boolean isException(java.lang.String name)

Tests 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.

isSuccessful

public boolean 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.