com.comphenix.xp.extra

Class ServiceProvider<TService extends Service>

java.lang.Object

com.comphenix.xp.extra.ServiceProvider<TService>

Type Parameters:

TService - - the type of each service that will be registered.

Direct Known Subclasses:

ChannelProvider, CustomBlockProviders, HistoryProviders, RewardProvider

public class ServiceProvider<TService extends Service>
extends java.lang.Object

Represents a string-based service registry.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	defaultServiceName
protected java.util.Set<java.lang.String>	disabledLookup
protected java.util.Map<java.lang.String,TService>	nameLookup

Constructor Summary

Constructors

Constructor and Description
ServiceProvider(java.lang.String defaultName)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsService(java.lang.String serviceName) Determines whether or not the given service has been registered.
void	enableAll() Enable all services.
TService	getByName(java.lang.String serviceName) Returns the currently registered service with this name.
java.lang.String	getDefaultName() Retrieves the default service by name.
TService	getDefaultService() Retrieves the default service, or the next non-disabled service if the default service is disabled.
java.lang.Iterable<TService>	getEnabledServices() Retrieves a collection of every enabled service.
java.util.Collection<TService>	getRegisteredServices() Retrieves a collection of every registered services.
boolean	isEnabled(java.lang.String name) Determines if a service is enabled.
boolean	isEnabled(TService service) Determines if a given service is enabled.
TService	register(TService service) Registers a service in the system.
protected TService	setByName(java.lang.String name, TService service) Called by the register function to associate a service with a name.
void	setDefaultName(java.lang.String defaultName) Sets the default service by name.
void	setEnabled(java.lang.String name, boolean value) Sets whether or not a service is enabled.
void	setEnabled(TService service, boolean value) Sets whether or not a service is enabled.
TService	unregister(java.lang.String serviceName) Unregisters a specified service.
TService	unregister(TService service) Unregisters a particular service.

Methods inherited from class java.lang.Object

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

Field Detail

defaultServiceName

public static java.lang.String defaultServiceName

nameLookup

protected java.util.Map<java.lang.String,TService extends Service> nameLookup

disabledLookup

protected java.util.Set<java.lang.String> disabledLookup

Constructor Detail

ServiceProvider

public ServiceProvider(java.lang.String defaultName)

Method Detail

getByName

public TService getByName(java.lang.String serviceName)

Returns the currently registered service with this name. The name should conform to the Java ENUM convention.

Parameters:

serviceName - - name to search for.

Returns:

The currently registered service, or NULL if not found.

Throws:

org.apache.commons.lang.NullArgumentException - If serviceName is null.

register

public TService register(TService service)

Registers a service in the system.

Parameters:

service - - the service to register.

Returns:

The previously registered service with this name, or NULL otherwise.

Throws:

org.apache.commons.lang.NullArgumentException - If service is null.

unregister

public TService unregister(java.lang.String serviceName)

Unregisters a specified service.

Parameters:

serviceName - - the name of the service to unregister.

Returns:

The previously registered service with this name, or NULL otherwise.

Throws:

org.apache.commons.lang.NullArgumentException - If serviceName is null.

containsService

public boolean containsService(java.lang.String serviceName)

Determines whether or not the given service has been registered.

Parameters:

serviceName - - name of the service to find.

Returns:

TRUE if it has, FALSE otherwise.

unregister

public TService unregister(TService service)

Unregisters a particular service.

Parameters:

service - - the service to unregister.

Returns:

The service that was unregistered, or NULL if this service has already been unregistered.

Throws:

org.apache.commons.lang.NullArgumentException - If service is null.

setByName

protected TService setByName(java.lang.String name,
                 TService service)

Called by the register function to associate a service with a name.

Parameters:

name - - name of the service to register.

service - - service to register.

Throws:

org.apache.commons.lang.NullArgumentException - Service name cannot be null.

getRegisteredServices

public java.util.Collection<TService> getRegisteredServices()

Retrieves a collection of every registered services.

Returns:

Collection of every registered service.

getEnabledServices

public java.lang.Iterable<TService> getEnabledServices()

Retrieves a collection of every enabled service.

Returns:

Every enabled service.

enableAll

public void enableAll()

Enable all services.

isEnabled

public boolean isEnabled(java.lang.String name)

Determines if a service is enabled.

Parameters:

name - - name of service.

Returns:

TRUE if the service is enabled, FALSE otherwise.

isEnabled

public boolean isEnabled(TService service)

Determines if a given service is enabled.

Parameters:

service - - service.

Returns:

TRUE if the service is enabled, FALSE otherwise.

setEnabled

public void setEnabled(java.lang.String name,
              boolean value)

Sets whether or not a service is enabled.

Parameters:

name - - name of service.

value - - TRUE if the service should be enabled, FALSE otherwise.

setEnabled

public void setEnabled(TService service,
              boolean value)

Sets whether or not a service is enabled.

Parameters:

service - - service.

value - - TRUE if the service should be enabled, FALSE otherwise.

getDefaultName

public java.lang.String getDefaultName()

Retrieves the default service by name.

Returns:

Default service name.

setDefaultName

public void setDefaultName(java.lang.String defaultName)

Sets the default service by name.

Parameters:

defaultName - default service name.

getDefaultService

public TService getDefaultService()

Retrieves the default service, or the next non-disabled service if the default service is disabled.

Returns:

The default service, or NULL if not found.