Class HitDieFormula

code/src/java/pcgen/cdom/processor/HitDieFormula.java:28–106

A HitDieFormula represents a modified HitDie that changes relative to a ReferenceFormula

 * ReferenceFormula
 */
public class HitDieFormula implements Processor<HitDie>
{

	/**
	 * The ReferenceFormula used by this HitDieFormula to modify an incoming
	 * HitDie.
	 */
	private final ReferenceFormula<Integer> formula;

	/**
	 * Constructs a new HitDieFormula object with the given ReferenceFormula to
	 * modify HitDie objects.
	 * 
	 * @param refFormula
	 *            A ReferenceFormula to modify a HitDie when this HitDieFormula
	 *            acts on a given HitDie
	 */
	public HitDieFormula(ReferenceFormula<Integer> refFormula)
	{
		formula = refFormula;
	}

	/**
	 * Applies this Processor to the given input HitDie, which modifies the given
	 * input HitDie with the formula provided at construction of the
	 * HitDieFormula.
	 * 
	 * Since HitDieFormula is universal, the given context is ignored.
	 * 
	 * @param origHD
	 *            The input HitDie this HitDieFormula will act upon.
	 * @param context
	 *            The context, ignored by HitDieFormula.
	 * @return The modified HitDie
	 * @throws NullPointerException
	 *             if the given HitDie is null
	 */
	@Override
	public HitDie applyProcessor(HitDie origHD, Object context)
	{
		return new HitDie(formula.resolve(origHD.getDie()));
	}

	/**
	 * Returns a representation of this HitDieFormula, suitable for storing in
	 * an LST file.
	 * 
	 * @return A representation of this HitDieFormula, suitable for storing in
	 *         an LST file.
	 */
	@Override
	public String getLSTformat()
	{
		return '%' + formula.toString();
	}

	/**
	 * The class of object this Processor acts upon (HitDie).