/*
 * Copyright 2014 (C) Tom Parker <thpr@users.sourceforge.net>
 * 
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 * 
 * This library 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 Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */
package pcgen.base.calculation;

import pcgen.base.formula.base.DependencyManager;

/**
 * An AbstractNEPCalculationis a basic template for creating a NEPCalculation.
 * No attempt is made to implement the process method (since a calculation with
 * nothing processed is meaningless), while an empty getDependencies method is
 * provided for convenience.
 * 
 * @param <T>
 *            The format of object upon which this AbstractNEPCalculation
 *            operates
 */
public abstract class AbstractNEPCalculation<T> implements NEPCalculation<T>
{
	/**
	 * The BasicCalculation underlying this AbstractNEPCalculation.
	 */
	private final BasicCalculation<T> basicCalc;

	/**
	 * Constructs a new AbstractNEPCalculation with the given BasicCalculation
	 * as the underlying calculation to be performed when this
	 * AbstractNEPCalculation is processed.
	 * 
	 * @param calc
	 *            The BasicCalculation to be performed when this
	 *            AbstractNEPCalculation is processed
	 */
	protected AbstractNEPCalculation(BasicCalculation<T> calc)
	{
		if (calc == null)
		{
			throw new IllegalArgumentException("BasicCalculation cannot be null");
		}
		basicCalc = calc;
	}

	@Override
	public Class<T> getVariableFormat()
	{
		return basicCalc.getVariableFormat();
	}

	@Override
	public String getIdentification()
	{
		return basicCalc.getIdentification();
	}

	@Override
	@SuppressWarnings("PMD.EmptyMethodInAbstractClassShouldBeAbstract")
	public void getDependencies(DependencyManager fdm)
	{
	}

	@Override
	public int getInherentPriority()
	{
		return basicCalc.getInherentPriority();
	}

	/**
	 * Returns the BasicCalculation underlying this AbstractNEPCalculation.
	 * 
	 * @return The BasicCalculation underlying this AbstractNEPCalculation
	 */
	public BasicCalculation<T> getBasicCalculation()
	{
		return basicCalc;
	}
}