sk.stuba.fiit.perconik.core

Interface Resource<L extends Listener>

Type Parameters:

L - the type of listeners compatible with this resource

All Superinterfaces:

Nameable, Registrable

All Known Subinterfaces:

DebugResource<L>

All Known Implementing Classes:

AbstractDebugResource, DebugListenerPool, DebugResourceProxy, ForwardingResource

public interface Resource<L extends Listener>
extends Nameable, Registrable

A resource for managing registrable Listener instances. In general a resource implements listener registration mechanism as well as other supporting utilities for specific listener type. Resource may be also a source of listener events or act as a bridge between the event source and the listeners.

Each resource is identified by its name returned by getName() method. Resource names should be fully qualified and unique for different resource implementations as resources with the same names are considered equal by the equals(Object) method.

A resource must use Listener.equals(java.lang.Object) to determine whether two listeners should be considered as the same. Similarly a resource should always check if it supports the encountered listener type and appropriately throw a ClassCastException. Resource does not permit null listeners.

Since:

1.0

Author:

Pavol Zbell

See Also:

Listener, Resources, DefaultResources

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compares the specified object with this resource for equality.
java.lang.String	getName() Returns a fully qualified name of this resource.
int	hashCode() Returns the hash code value for this resource.
void	register(L listener) Registers a listener to this resource.
<U extends Listener> java.util.Collection<U>	registered(java.lang.Class<U> type) Returns all registered listeners assignable to the specified listener type.
boolean	registered(Listener listener) Determines whether the specified listener is registered to this resource.
void	unregister(L listener) Unregisters a listener from this resource.

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

postRegister, postUnregister, preRegister, preUnregister

Method Detail

register

void register(L listener)

Registers a listener to this resource.

Warning: Does not invoke listener registration hooks. Only ListenerManager.register(Listener) is responsible for proper hook method invocation during the registration process.

Parameters:

listener - the listener to be registered, not null

Throws:

java.lang.ClassCastException - if the type of the specified listener prevents it from being registered to this resource

ListenerAlreadyRegistredException - if the specified listener is already registered and this resource panics

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

UnsupportedResourceException - if the resource does not support this operation (it could mean that it is not implemented yet)

unregister

void unregister(L listener)

Unregisters a listener from this resource.

Warning: Does not invoke listener unregistration hooks. Only ListenerManager.unregister(Listener) is responsible for proper hook method invocation during the unregistration process.

Parameters:

listener - the listener to be unregistered, not null

Throws:

java.lang.ClassCastException - if the type of the specified listener prevents it from being unregistered from this resource

ListenerNotRegistredException - if the specified listener is not registered and this resource panics

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

UnsupportedResourceException - if the resource does not support this operation (it could mean that it is not implemented yet)

registered

<U extends Listener> java.util.Collection<U> registered(java.lang.Class<U> type)

Returns all registered listeners assignable to the specified listener type. A listener is assignable to a listener type if it is an instance of that type.

Parameters:

type - the listener type of the registered listeners, not null

Throws:

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

registered

boolean registered(Listener listener)

Determines whether the specified listener is registered to this resource.

Parameters:

listener - the listener to be checked, not null

Returns:

true if the specified listener is registered to this resource, false otherwise

Throws:

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

equals

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

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

Overrides:

equals in class java.lang.Object

Parameters:

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

Returns:

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

hashCode

int hashCode()

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

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code value for this resource

getName

java.lang.String getName()

Returns a fully qualified name of this resource.

Specified by:

getName in interface Nameable

Returns:

the fully qualified name