Class HitDieStep

code/src/java/pcgen/cdom/processor/HitDieStep.java:32–195

A HitDieStep represents a modified HitDie that changes along the path of Hit Dice defined in the Game Mode. A bound may be set in order to limit movement beyond a given point. Because the number of steps that this HitDieStep will apply is provided during construction, the object constructing this H

 * understand if it is setting an upper or lower bound.
 */
public class HitDieStep implements Processor<HitDie>
{

	/**
	 * The number of steps by which this HitDieStep object will modify the
	 * incoming HitDie.
	 */
	private final int numSteps;

	/**
	 * The bound beyond which this HitDieStep will not modify the incoming
	 * HitDie. This bound overrides the number of steps to be taken, if the
	 * bound is reached.
	 */
	private final HitDie dieLimit;

	/**
	 * Constructs a new HitDieStep object with the given number of steps and
	 * bound.
	 * 
	 * Because the number of steps that this HitDieStep will apply is provided
	 * during construction, the object constructing this HitDieStep is expected
	 * to understand if it is setting an upper or lower bound.
	 * 
	 * *NOTE* if the HitDie provided as a bound is not in the global sequence of
	 * HitDie objects (defined in the Game Mode), then this method will fail to
	 * stop at the bound. Matching on this bound is exact.
	 * 
	 * @param steps
	 *            The number of steps this HitDieStep will modify the incoming
	 *            HitDie provided to applyProcessor
	 * @param stopAt
	 *            The bound, indicating the HitDie at which the HitDitStep will
	 *            not proceed. This bound overrides the number of steps to be
	 *            taken, if the bound is reached. This bound may be null to
	 *            indicate there is no bound.
	 * @throws IllegalArgumentException
	 *             if the number of steps is zero (since that is effectively a
	 *             pass-through, no Processor is required)
	 */
	public HitDieStep(int steps, HitDie stopAt)
	{
		if (steps == 0)
		{
			throw new IllegalArgumentException();
		}
		numSteps = steps;
		dieLimit = stopAt;
	}

	/**
	 * Applies this Processor to the given input object, in the context of the
	 * given context object.
	 * 
	 * *NOTE* if the HitDie provided is not in the global sequence of HitDie
	 * objects (defined in the Game Mode), then this method will fail to step
	 * that HitDie, and the original, unmodified HitDie will be returned.
	 *