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

Interface ResourceProvider

All Superinterfaces:

Nameable, Provider

All Known Subinterfaces:

DebugResourceProvider

All Known Implementing Classes:

AbstractResourceProvider, DebugResourceProviderProxy, ForwardingResourceProvider

public interface ResourceProvider
extends Provider

An object responsible for providing Resource instances.

Since:

1.0

Author:

Pavol Zbell

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ResourceProvider.Builder A builder for creating resource provider instances.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compares the specified object with this provider for equality.
Resource<?>	forName(java.lang.String name) Returns a resource with the specified name.
<L extends Listener> java.util.Set<Resource<L>>	forType(java.lang.Class<L> type) Returns a set of resources supporting the specified listener type.
int	hashCode() Returns the hash code value for this provider.
java.util.Set<java.lang.String>	names() Returns names of all provided resources.
ResourceProvider	parent() Returns the resource provider's parent or null if there is no parent.
java.util.Set<java.lang.Class<? extends Listener>>	types() Returns listener types supported by provided resources.

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

getName

Method Detail

forName

Resource<?> forName(java.lang.String name)

Returns a resource with the specified name.

This method is guaranteed to return the same resource instance for the specified resource name every time it is invoked.

Parameters:

name - the resource name, not an empty string or null

Returns:

the resulting Resource object

Throws:

java.lang.IllegalArgumentException - if the specified resource name is an empty string

java.lang.NullPointerException - if the specified resource name is null

ResourceNotFoundException - if no definition of the resource could be found by the specified name

IllegalResourceClassException - if the resource implementation class is invalid

ResourceInstantiationException - if the resource instantiation failed

forType

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

Returns a set of resources supporting the specified listener type.

Parameters:

type - the listener type, not null

Returns:

a set of resources supporting the specified listener type

Throws:

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

ResourceNotFoundException - if no definition of the resource could be found by the specified name

IllegalResourceClassException - if the resource implementation class is invalid

ResourceInstantiationException - if the resource instantiation failed

names

java.util.Set<java.lang.String> names()

Returns names of all provided resources.

types

java.util.Set<java.lang.Class<? extends Listener>> types()

Returns listener types supported by provided resources.

parent

ResourceProvider parent()

Returns the resource provider's parent or null if there is no parent. Standard implementations should return system resource provider if there is no direct parent (only the system resource provider returns null as it is at the top of the resource provider hierarchy).

Specified by:

parent in interface Provider

See Also:

ResourceProviders.superResourceProvider()

equals

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

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

Specified by:

equals in interface Provider

Overrides:

equals in class java.lang.Object

Parameters:

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

Returns:

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

hashCode

int hashCode()

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

Specified by:

hashCode in interface Provider

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code value for this provider