com.tangosol.util

Class NullImplementation.NullResourceRegistry

java.lang.Object

com.tangosol.util.NullImplementation.NullResourceRegistry

All Implemented Interfaces:

com.oracle.coherence.common.base.Disposable, ResourceRegistry, ResourceResolver, AutoCloseable

Enclosing class:

NullImplementation

public static class NullImplementation.NullResourceRegistry
extends Object
implements ResourceRegistry

A ResourceRegistry implementation that does nothing.

Nested Class Summary

Nested classes/interfaces inherited from interface com.tangosol.util.ResourceRegistry

ResourceRegistry.ResourceLifecycleObserver<R>

Field Summary

Fields

Modifier and Type	Field and Description
static NullImplementation.NullResourceRegistry	INSTANCE Singleton instance of a NullResourceRegistry.

Fields inherited from interface com.tangosol.util.ResourceRegistry

DEFAULT_NAME

Constructor Summary

Constructors

Constructor and Description
NullResourceRegistry()

Method Summary

Modifier and Type	Method and Description
void	dispose() Invoked when all resources owned by the implementer can safely be released.
<R> R	getResource(Class<R> clsResource) Attempts to retrieve the resource that was registered with the specified class.
<R> R	getResource(Class<R> clsResource, String sResourceName) Attempts to retrieve the resource that was registered with the specified class and name.
<R> String	registerResource(Class<R> clzResource, Builder<? extends R> bldrResource, RegistrationBehavior behavior, ResourceRegistry.ResourceLifecycleObserver<R> observer) Registers a resource according to the specified RegistrationBehavior.
<R> String	registerResource(Class<R> clzResource, R resource) Registers the resource for later retrieval with ResourceResolver.getResource(Class).
<R> String	registerResource(Class<R> clzResource, String sResourceName, Builder<? extends R> bldrResource, RegistrationBehavior behavior, ResourceRegistry.ResourceLifecycleObserver<R> observer) Registers a resource according to the specified RegistrationBehavior.
<R> String	registerResource(Class<R> clzResource, String sResourceName, R resource) Registers the resource with the specified name for later retrieval with ResourceResolver.getResource(Class, String).
<R> void	unregisterResource(Class<R> clzResource, String sResourceName) Unregisters the resource that was previously registered of the specified class and name.

Methods inherited from class java.lang.Object

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

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

close

Field Detail

INSTANCE

public static final NullImplementation.NullResourceRegistry INSTANCE

Singleton instance of a NullResourceRegistry.

Constructor Detail

NullResourceRegistry

public NullResourceRegistry()

Method Detail

registerResource

public <R> String registerResource(Class<R> clzResource,
                                   R resource)

Description copied from interface: ResourceRegistry

Registers the resource for later retrieval with ResourceResolver.getResource(Class).

Notes:

1. Multiple resources for the same class can be registered if each resource is registered with a unique name via ResourceRegistry.registerResource(Class, String, Object)
2. Registration of resources will occur in a thread-safe manner.
3. Resources that are Disposable will be disposed when the ResourceRegistry is disposed.

Specified by:

registerResource in interface ResourceRegistry

Parameters:

clzResource - the class of the resource

resource - the resource

Returns:

the actual name used to register the resource

registerResource

public <R> String registerResource(Class<R> clzResource,
                                   String sResourceName,
                                   R resource)

Description copied from interface: ResourceRegistry

Registers the resource with the specified name for later retrieval with ResourceResolver.getResource(Class, String).

Notes:

1. Registration of resources will occur in a thread-safe manner.
2. Resources that are Disposable will be disposed when the ResourceRegistry is disposed.

Specified by:

registerResource in interface ResourceRegistry

Parameters:

clzResource - the class of the resource

sResourceName - the proposed name of the resource

resource - the resource

Returns:

the actual name used to register the resource

registerResource

public <R> String registerResource(Class<R> clzResource,
                                   Builder<? extends R> bldrResource,
                                   RegistrationBehavior behavior,
                                   ResourceRegistry.ResourceLifecycleObserver<R> observer)

Description copied from interface: ResourceRegistry

Registers a resource according to the specified RegistrationBehavior. If successful the registered resource may later be retrieved using method ResourceResolver.getResource(Class).

Notes:

1. Multiple resources for the same class can be registered if each resource is registered with a unique name via ResourceRegistry.registerResource(Class, String, Builder, RegistrationBehavior, ResourceLifecycleObserver)
2. Registration of resources will occur in a thread-safe manner.
3. Resources that are Disposable will be disposed when the ResourceRegistry is disposed.

Specified by:

registerResource in interface ResourceRegistry

Type Parameters:

R - the type of the resource

Parameters:

clzResource - the class of the resource

bldrResource - the Builder to realize the resource to register (if required the specified behavior requires a resource)

behavior - the RegistrationBehavior to use

observer - an optional ResourceRegistry.ResourceLifecycleObserver that will be called when the resource is being released from the ResourceRegistry (may be null)

Returns:

the actual name used to register the resource

registerResource

public <R> String registerResource(Class<R> clzResource,
                                   String sResourceName,
                                   Builder<? extends R> bldrResource,
                                   RegistrationBehavior behavior,
                                   ResourceRegistry.ResourceLifecycleObserver<R> observer)
                            throws IllegalArgumentException

Description copied from interface: ResourceRegistry

Registers a resource according to the specified RegistrationBehavior. If successful the registered resource may later be retrieved using method ResourceResolver.getResource(Class, String).

Notes:

1. Registration of resources will occur in a thread-safe manner.
2. Resources that are Disposable will be disposed when the ResourceRegistry is disposed.

Specified by:

registerResource in interface ResourceRegistry

Type Parameters:

R - the type of the resource

Parameters:

clzResource - the class of the resource

sResourceName - the proposed name of the resource

bldrResource - the Builder to realize the resource to register (if required the specified behavior requires a resource)

behavior - the RegistrationBehavior to use

observer - an optional ResourceRegistry.ResourceLifecycleObserver that will be called when the resource is being released from the ResourceRegistry (may be null)

Returns:

the actual name used to register the resource

Throws:

IllegalArgumentException - if a resource with the specified class is already registered with the ResourceRegistry and the behavior was RegistrationBehavior.FAIL

unregisterResource

public <R> void unregisterResource(Class<R> clzResource,
                                   String sResourceName)

Description copied from interface: ResourceRegistry

Unregisters the resource that was previously registered of the specified class and name.

Note: Unregistering a resource does not cause it to be disposed, but it does call ResourceRegistry.ResourceLifecycleObserver.onRelease(Object) if an observer was provided at the time of registration.

Specified by:

unregisterResource in interface ResourceRegistry

Type Parameters:

R - the type of the resource

Parameters:

clzResource - the class of the resource

sResourceName - the name of the resource

getResource

public <R> R getResource(Class<R> clsResource)

Description copied from interface: ResourceResolver

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

Specified by:

getResource in interface ResourceResolver

Type Parameters:

R - the type of the resource

Parameters:

clsResource - the class of the resource

Returns:

the registered resource or null if the resource is unknown to the ResourceRegistry

getResource

public <R> R getResource(Class<R> clsResource,
                         String sResourceName)

Description copied from interface: ResourceResolver

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

Specified by:

getResource in interface ResourceResolver

Type Parameters:

R - the type of the resource

Parameters:

clsResource - the class of the resource

sResourceName - the name of the resource

Returns:

the registered resource or null if the resource is unknown to the ResourceRegistry

dispose

public void dispose()

Description copied from interface: com.oracle.coherence.common.base.Disposable

Invoked when all resources owned by the implementer can safely be released.

Once disposed of the object should no longer be considered to be usable.

Note the Disposable interface is compatible with try-with-resources which will automatically invoke this method.

Specified by:

dispose in interface com.oracle.coherence.common.base.Disposable