Class HitDieLock

code/src/java/pcgen/cdom/processor/HitDieLock.java:31–108

A HitDieLock represents a constrained HitDie that does not change. Since this acts as a Processor, the effect of the application of this Processor is unconditional return of the HitDie object provided at construction of the HitDieLock object.

 * HitDieLock object.
 */
public class HitDieLock implements Processor<HitDie>
{

	/**
	 * The HitDie to which this HitDieLock is "locked"
	 */
	private final HitDie hitDie;

	/**
	 * Constructs a new HitDieLock which will unconditionally return the given
	 * HitDie object.
	 * 
	 * @param die
	 *            The HitDie for this HitDieLock
	 * @throws IllegalArgumentException
	 *             if the given HitDie is null
	 */
	public HitDieLock(HitDie die)
	{
		Objects.requireNonNull(die, "Die for HitDieLock cannot be null");
		hitDie = die;
	}

	/**
	 * Applies this Processor by returning the HitDie to which this HitDieLock is
	 * set.
	 * 
	 * Since HitDieLock is universal, the given context is ignored.
	 * 
	 * @param origHD
	 *            The input HitDie this Processor will act upon
	 * @param context
	 *            The context of this Processor, ignored by HitDieLock.
	 * @return The modified object, of the same class as the input object.
	 */
	@Override
	public HitDie applyProcessor(HitDie origHD, Object context)
	{
		return hitDie;
	}

	/**
	 * Returns a representation of this HitDieLock, suitable for storing in an
	 * LST file.
	 * 
	 * @return A representation of this HitDieLock, suitable for storing in an
	 *         LST file.
	 */
	@Override
	public String getLSTformat()
	{
		return Integer.toString(hitDie.getDie());
	}

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