com.comphenix.xp.rewards

Class RewardProvider

java.lang.Object

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

com.comphenix.xp.rewards.RewardProvider

public class RewardProvider
extends ServiceProvider<RewardService>

API for adding or removing reward managers.

Author:

Kristian

Field Summary

Fields inherited from class com.comphenix.xp.extra.ServiceProvider

defaultServiceName, disabledLookup, nameLookup

Constructor Summary

Constructors

Constructor and Description
RewardProvider()
RewardProvider(RewardProvider reference, Configuration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsReward(RewardTypes type) Determines whether or not the given reward type has been registered.
RewardProvider	createView(Configuration config) Creates a copy of this reward provider with shallow references to the same list of rewards, except with a different internal default reward type.
RewardService	getByEnum(RewardTypes rewardType) Returns the currently registered reward service for this type.
RewardService	getByName(java.lang.String rewardName) Returns the currently registered service with this name.
Configuration	getConfiguration() Retrieves the configuration containing settings for different reward services.
RewardService	register(RewardService reward) Registers a service in the system.
void	setConfiguration(Configuration configuration) Sets the configuration containing settings for different reward services.
void	setDefaultReward(RewardTypes defaultType) Sets the default reward service by type.
RewardService	unregister(RewardTypes rewardType) Unregisters a specified reward service.
RewardService	unregister(java.lang.String rewardName) Unregisters a specified service.

Methods inherited from class com.comphenix.xp.extra.ServiceProvider

containsService, enableAll, getDefaultName, getDefaultService, getEnabledServices, getRegisteredServices, isEnabled, isEnabled, setByName, setDefaultName, setEnabled, setEnabled, unregister

Methods inherited from class java.lang.Object

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

Constructor Detail

RewardProvider

public RewardProvider()

RewardProvider

public RewardProvider(RewardProvider reference,
              Configuration configuration)

Method Detail

getByEnum

public RewardService getByEnum(RewardTypes rewardType)

Returns the currently registered reward service for this type.

Parameters:

rewardType - - type to search for.

Returns:

The currently registered reward service, or NULL if not found.

getByName

public RewardService getByName(java.lang.String rewardName)

Description copied from class: ServiceProvider

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

Overrides:

getByName in class ServiceProvider<RewardService>

Parameters:

rewardName - - name to search for.

Returns:

The currently registered service, or NULL if not found.

register

public RewardService register(RewardService reward)

Description copied from class: ServiceProvider

Registers a service in the system.

Overrides:

register in class ServiceProvider<RewardService>

Parameters:

reward - - the service to register.

Returns:

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

unregister

public RewardService unregister(RewardTypes rewardType)

Unregisters a specified reward service.

Parameters:

rewardType - the type of the reward service to unregister.

Returns:

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

unregister

public RewardService unregister(java.lang.String rewardName)

Description copied from class: ServiceProvider

Unregisters a specified service.

Overrides:

unregister in class ServiceProvider<RewardService>

Parameters:

rewardName - - the name of the service to unregister.

Returns:

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

containsReward

public boolean containsReward(RewardTypes type)

Determines whether or not the given reward type has been registered.

Parameters:

type - - type of the reward to check.

Returns:

TRUE if it has, FALSE otherwise.

createView

public RewardProvider createView(Configuration config)

Creates a copy of this reward provider with shallow references to the same list of rewards, except with a different internal default reward type. This allows multiple copies of the provider to reference the same rewards, but use a different default reward service.

Parameters:

config - Configuration settings for the different services.

Returns:

A shallow copy of this reward service provider.

setDefaultReward

public void setDefaultReward(RewardTypes defaultType)

Sets the default reward service by type.

Parameters:

defaultType - default reward service type.

getConfiguration

public Configuration getConfiguration()

Retrieves the configuration containing settings for different reward services.

Returns:

The configuration file.

setConfiguration

public void setConfiguration(Configuration configuration)

Sets the configuration containing settings for different reward services.

Parameters:

configuration - New configuration.