RewardProvider.java

/*
 *  ExperienceMod - Bukkit server plugin for modifying the experience system in Minecraft.
 *  Copyright (C) 2012 Kristian S. Stangeland
 *
 *  This program is free software; you can redistribute it and/or modify it under the terms of the 
 *  GNU General Public License as published by the Free Software Foundation; either version 2 of 
 *  the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
 *  without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 *  See the GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along with this program; 
 *  if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
 *  02111-1307 USA
 */

package com.comphenix.xp.rewards;

import java.util.HashMap;

import org.apache.commons.lang.NullArgumentException;

import com.comphenix.xp.Configuration;
import com.comphenix.xp.extra.ServiceProvider;
import com.comphenix.xp.rewards.RewardTypes;

/**
 * API for adding or removing reward managers.
 * 
 * @author Kristian
 */
public class RewardProvider extends ServiceProvider<RewardService> {
	
	// Error messages
	private static String ERROR_CUSTOM_UNSUPPORTED = "rewardType cannot be CUSTOM.";
	
	// Enum type lookup
	private transient HashMap<RewardTypes, RewardService> enumLookup;
	private Configuration configuration;
	
	public RewardProvider() {
		// Default constructor
		super("EXPERIENCE");
		this.nameLookup = new HashMap<String, RewardService>();
		this.enumLookup = new HashMap<RewardTypes, RewardService>();
	}
	
	@SuppressWarnings("unchecked")
	public RewardProvider(RewardProvider reference, Configuration configuration) {
		super(reference);
		this.enumLookup = (HashMap<RewardTypes, RewardService>) reference.enumLookup.clone();
		this.configuration = configuration;
	}
	
	/**
	 * Returns the currently registered reward service for this type.
	 * @param rewardType - type to search for.
	 * @return The currently registered reward service, or NULL if not found.
	 */
	public RewardService getByEnum(RewardTypes rewardType) {
		if (rewardType == null)
			throw new NullArgumentException("rewardType");
		if (rewardType == RewardTypes.CUSTOM)
			throw new IllegalArgumentException(ERROR_CUSTOM_UNSUPPORTED);
		if (rewardType == RewardTypes.DEFAULT)
			return getByName(defaultServiceName);
		
		// Add configuration here too
		return getConfigSpecific(enumLookup.get(rewardType));
	}
	
	@Override
	public RewardService getByName(String rewardName) {
		
		// Add configuration
		return getConfigSpecific(super.getByName(rewardName));
	}
	
	@Override
	public RewardService register(RewardService reward) {
		if (reward == null)
			throw new NullArgumentException("reward");
		
		RewardTypes type = reward.getRewardType();

		// Add to lookup
		if (type != RewardTypes.CUSTOM) {
			enumLookup.put(type, reward);
		} else if (type == RewardTypes.DEFAULT) {
			throw new IllegalArgumentException("Reward type cannot be DEFAULT.");
		}
		
		// Register with name
		return super.register(reward);
	}
	
	/**
	 * Unregisters a specified reward service.
	 * @param rewardType the type of the reward service to unregister.
	 * @return The previously registered service with this type, or NULL otherwise.
	 */
	public RewardService unregister(RewardTypes rewardType) {
		if (rewardType == null)
			throw new NullArgumentException("rewardType");
		if (rewardType == RewardTypes.CUSTOM)
			throw new IllegalArgumentException(ERROR_CUSTOM_UNSUPPORTED);
		if (rewardType == RewardTypes.DEFAULT)
			return super.unregister(defaultServiceName);
		
		RewardService removed = enumLookup.remove(rewardType);
		
		// Make sure to remove it from the name list too
		if (removed != null)
			super.unregister(removed);
		return removed;
	}
	
	@Override
	public RewardService unregister(String rewardName) {

		RewardService removed = super.unregister(rewardName);
		
		if (!removed.getRewardType().isSpecialMarker())
			enumLookup.remove(removed.getRewardType());
		return removed;
	}
	
	/**
	 * Determines whether or not the given reward type has been registered.
	 * @param type - type of the reward to check.
	 * @return TRUE if it has, FALSE otherwise.
	 */
	public boolean containsReward(RewardTypes type) {
		if (type == RewardTypes.DEFAULT)
			return containsService(getDefaultName());
		else if (type == RewardTypes.CUSTOM)
			throw new IllegalArgumentException(ERROR_CUSTOM_UNSUPPORTED);
		
		return enumLookup.containsKey(type);
	}
	
	// Make sure the reward manager has the correct configuration associated with it
	private RewardService getConfigSpecific(RewardService reward) {
		
		if (reward == null)
			return null;
		else if (configuration != null)
			return reward.clone(configuration);
		else 
			return reward;
	}
	
	/**
	 * 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.
	 * @param config Configuration settings for the different services.
	 * @return A shallow copy of this reward service provider.
	 */
	public RewardProvider createView(Configuration config) {
		return new RewardProvider(this, config);
	}
	
	/**
	 * Sets the default reward service by type.
	 * @param defaultType default reward service type.
	 */
	public void setDefaultReward(RewardTypes defaultType) {
		if (defaultType == RewardTypes.DEFAULT)
			throw new IllegalArgumentException("The default type cannot reference itself.");
		else if (defaultType == RewardTypes.CUSTOM)
			throw new IllegalArgumentException(ERROR_CUSTOM_UNSUPPORTED);
		
		setDefaultName(defaultType.name());
	}
	
	/**
	 * Retrieves the configuration containing settings for different reward services.
	 * @return The configuration file.
	 */
	public Configuration getConfiguration() {
		return configuration;
	}
	
	/**
	 * Sets the configuration containing settings for different reward services.
	 * @param configuration New configuration.
	 */
	public void setConfiguration(Configuration configuration) {
		this.configuration = configuration;
	}
}