com.tangosol.coherence.config.builder

Interface ParameterizedBuilderRegistry

All Superinterfaces:

AutoCloseable, com.oracle.coherence.common.base.Disposable, Iterable<ParameterizedBuilderRegistry.Registration>

All Known Implementing Classes:

SimpleParameterizedBuilderRegistry

public interface ParameterizedBuilderRegistry
extends com.oracle.coherence.common.base.Disposable, Iterable<ParameterizedBuilderRegistry.Registration>

A registry of strongly typed and possibly named ParameterizedBuilders.

When a ParameterizedBuilder is registered with a ParameterizedBuilderRegistry, the ParameterizedBuilderRegistry assumes ownership of the said builder, up until at which point the ParameterizedBuilderRegistry is disposed.

Important: Although a ParameterizedBuilderRegistry manages builders in a thread-safe manner, it is possible for a thread calling getBuilder(Class, String) to receive a null return value while another thread is registering a builder.

Since:

Coherence 12.1.3

Author:

bo 2014.10.27

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ParameterizedBuilderRegistry.Registration<T> Defines a single ParameterizedBuilder registration with a ParameterizedBuilderRegistry.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME The name to use for the registration of a singleton and thus default resource.

Method Summary

Modifier and Type	Method and Description
<T> ParameterizedBuilder<T>	getBuilder(Class<T> clzInstance) Attempts to retrieve the builder that was registered with the specified class.
<T> ParameterizedBuilder<T>	getBuilder(Class<T> clzInstance, String sBuilderName) Attempts to retrieve the builder that was registered with the specified class and name.
<T> String	registerBuilder(Class<T> clzInstance, ParameterizedBuilder<? extends T> builder) Registers a ParameterizedBuilder for later retrieval with getBuilder(Class).
<T> String	registerBuilder(Class<T> clzInstance, String sBuilderName, ParameterizedBuilder<? extends T> builder) Registers a ParameterizedBuilder with the specified name for later retrieval with getBuilder(Class, String).

Methods inherited from interface com.oracle.coherence.common.base.Disposable

close, dispose

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

DEFAULT_NAME

static final String DEFAULT_NAME

The name to use for the registration of a singleton and thus default resource.

See Also:

Constant Field Values

Method Detail

getBuilder

<T> ParameterizedBuilder<T> getBuilder(Class<T> clzInstance)

Attempts to retrieve the builder that was registered with the specified class.

Type Parameters:

T - the type of the instance that will be produced by the builder

Parameters:

clzInstance - the class of the instance

Returns:

the registered builder or null if the builder is unknown to the ParameterizedBuilderRegistry

getBuilder

<T> ParameterizedBuilder<T> getBuilder(Class<T> clzInstance,
                                       String sBuilderName)

Attempts to retrieve the builder that was registered with the specified class and name.

Type Parameters:

T - the type of the instance that will be produced by the builder

Parameters:

clzInstance - the class of the instance

sBuilderName - the name of the builder

Returns:

the registered builder or null if the builder is unknown to the ParameterizedBuilderRegistry

registerBuilder

<T> String registerBuilder(Class<T> clzInstance,
                           ParameterizedBuilder<? extends T> builder)
                    throws IllegalArgumentException

Registers a ParameterizedBuilder for later retrieval with getBuilder(Class).

Notes:

1. Multiple builders for the same class can be registered if each builder is registered with a unique name via registerBuilder(Class, String, ParameterizedBuilder)
2. Registration of builders will occur in a thread-safe manner.
3. Builders that are Disposable will be disposed when the ParameterizedBuilderRegistry is disposed.

Parameters:

clzInstance - the class of instances produced by the builder

builder - the builder

Returns:

the actual name used to register the builder

Throws:

IllegalArgumentException - if a builder of the same specified type is already registered

registerBuilder

<T> String registerBuilder(Class<T> clzInstance,
                           String sBuilderName,
                           ParameterizedBuilder<? extends T> builder)
                    throws IllegalArgumentException

Registers a ParameterizedBuilder with the specified name for later retrieval with getBuilder(Class, String).

Notes:

1. Registration of builders will occur in a thread-safe manner.
2. Builders that are Disposable will be disposed when the ParameterizedBuilderRegistry is disposed.

Parameters:

clzInstance - the class of instances produced by the builder

builder - the builder

sBuilderName - the proposed name of the builder

Returns:

the actual name used to register the builder

Throws:

IllegalArgumentException - if a builder of the same specified type and name is already registered