sk.stuba.fiit.perconik.core.services.resources

Interface ResourceManager

All Superinterfaces:

Manager, Nameable

All Known Subinterfaces:

DebugResourceManager

All Known Implementing Classes:

AbstractResourceManager, DebugResourceManagerProxy, ForwardingResourceManager

public interface ResourceManager
extends Manager

An object responsible for managing registrations of Resource instances.

Since:

1.0

Author:

Pavol Zbell

Method Summary

Modifier and Type	Method and Description
<L extends Listener> java.util.Set<Resource<? extends L>>	assignables(java.lang.Class<L> type) Returns a set of resources assignable to the specified listener type.
boolean	equals(java.lang.Object o) Compares the specified object with this manager for equality.
int	hashCode() Returns the hash code value for this manager.
<L extends Listener> void	register(java.lang.Class<L> type, Resource<? super L> resource) Registers a resource with the given listener type.
boolean	registered(java.lang.Class<? extends Listener> type, Resource<?> resource) Determines whether the specified resource is registered with the specified listener type by this resource manager.
<L extends Listener> java.util.Set<Resource<? super L>>	registrables(java.lang.Class<L> type) Returns a set of resources registrable with the specified listener type.
com.google.common.collect.SetMultimap<java.lang.Class<? extends Listener>,Resource<?>>	registrations() Returns a set multimap of listener types to all registered resources.
<L extends Listener> void	unregister(java.lang.Class<L> type, Resource<? super L> resource) Unregisters a resource with the given listener type.
<L extends Listener> void	unregisterAll(java.lang.Class<L> type) Unregisters all resources assignable to the specified listener type.

Methods inherited from interface sk.stuba.fiit.perconik.core.Nameable

getName

Method Detail

register

<L extends Listener> void register(java.lang.Class<L> type,
                                   Resource<? super L> resource)

Registers a resource with the given listener type. Resource registration hooks are properly invoked during the registration process.

Note that this method propagates any exception thrown by the specified resource as a cause of a ResourceRegistrationException instance.

Parameters:

type - the listener type with which the specified resource is to be registered, not null

resource - the resource to be registered with the specified listener type, not null

Throws:

java.lang.IllegalArgumentException - if the specified resource implementation does not support the specified listener type

ResourceAlreadyRegistredException - if the specified listener type and resource pair is already registered and this resource manager panics

ResourceRegistrationException - if an exception is thrown by the specified resource during the registration process

java.lang.NullPointerException - if either of listener type or resource is null

unregister

<L extends Listener> void unregister(java.lang.Class<L> type,
                                     Resource<? super L> resource)

Unregisters a resource with the given listener type. Resource unregistration hooks are properly invoked during the unregistration process.

Note that this method propagates any exception thrown by the specified resource as a cause of a ResourceUnregistrationException instance.

Parameters:

type - the listener type with which the specified resource is to be unregistered, not null

resource - the resource to be unregistered from the specified listener type, not null

Throws:

java.lang.IllegalArgumentException - if the specified resource implementation does not support the specified listener type

ResourceNotRegistredException - if the specified listener type and resource pair is not registered and this resource manager panics

ResourceUnregistrationException - if an exception is thrown by the specified resource during the unregistration process

java.lang.NullPointerException - if either of listener type or resource is null

unregisterAll

<L extends Listener> void unregisterAll(java.lang.Class<L> type)

Unregisters all resources assignable to the specified listener type. A resource is assignable to a given listener type if the listener type supported by the resource is assignable to the given listener type. Resource unregistration hooks are properly invoked for all matched resources during the unregistration process.

Note that this method collects all exceptions thrown by resources during the unregistration process and propagates them as suppressed exceptions of a ResourceUnregistrationException instance.

Parameters:

type - the listener type to which the assignable resources are going be unregistered, not null

Throws:

ResourceUnregistrationException - if an exception is thrown by one or more resources during the unregistration process

java.lang.NullPointerException - if the specified listener type is null

assignables

<L extends Listener> java.util.Set<Resource<? extends L>> assignables(java.lang.Class<L> type)

Returns a set of resources assignable to the specified listener type.

A resource is assignable to a given listener type if the listener type supported by the resource is assignable to the given listener type.

registrables

<L extends Listener> java.util.Set<Resource<? super L>> registrables(java.lang.Class<L> type)

Returns a set of resources registrable with the specified listener type.

A resource is registrable with a given listener type if the listener type supported by the resource is equal to the given listener type or one of its superinterfaces.

registrations

com.google.common.collect.SetMultimap<java.lang.Class<? extends Listener>,Resource<?>> registrations()

Returns a set multimap of listener types to all registered resources.

registered

boolean registered(java.lang.Class<? extends Listener> type,
                   Resource<?> resource)

Determines whether the specified resource is registered with the specified listener type by this resource manager.

Parameters:

type - the listener type to be checked, not null

resource - the resource to be checked, not null

Returns:

true if the specified resource is registered with the specified listener type by this resource manager, false otherwise

Throws:

java.lang.NullPointerException - if either of listener type or resource is null

equals

boolean equals(@Nullable
               java.lang.Object o)

Compares the specified object with this manager for equality. Returns true if the specified object is also manager and the two managers have the same name. This definition ensures that this method works properly across different implementations of the manager interface.

Specified by:

equals in interface Manager

Overrides:

equals in class java.lang.Object

Parameters:

o - an object to be compared for equality with this manager

Returns:

true if the specified object is equal to this manager, false otherwise

hashCode

int hashCode()

Returns the hash code value for this manager. The hash code of a manager should be equivalent to the hash code of the manager's name.

Specified by:

hashCode in interface Manager

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code value for this manager