Class FixedSizeFormula

code/src/java/pcgen/cdom/formula/FixedSizeFormula.java:35–161

A FixedSizeFormula is a Formula that returns a deterministic value, used to uniquely identify a SizeAdjustment. The SizeAdjustment for which this Formula will return the value must be defined during construction of the FixedSizeFormula.

 * FixedSizeFormula.
 */
public class FixedSizeFormula implements Formula
{

	/**
	 * The underlying SizeAdjustment for which this Formula will return the
	 * identifying value.
	 */
	private final CDOMSingleRef<SizeAdjustment> size;

	/**
	 * Creates a new FixedSizeFormula for the given SizeAdjustment.
	 * 
	 * @param sAdj
	 *            The SizeAdjustment for which this Formula will return the
	 *            identifying value.
	 * @throws IllegalArgumentException
	 *             if the given SizeAdjustment is null
	 */
	public FixedSizeFormula(CDOMSingleRef<SizeAdjustment> sAdj)
	{
		Objects.requireNonNull(sAdj, "Size Adjustment for FixedSizeFormula cannot be null");
		size = sAdj;
	}

	/**
	 * Returns a String representation of this FixedSizeFormula, primarily for
	 * purposes of debugging. It is strongly advised that no dependency on this
	 * method be created, as the return value may be changed without warning.
	 */
	@Override
	public String toString()
	{
		return size.getLSTformat(false);
	}

	@Override
	public int hashCode()
	{
		return size.hashCode();
	}

	@Override
	public boolean equals(Object obj)
	{
		return obj instanceof FixedSizeFormula && size.equals(((FixedSizeFormula) obj).size);
	}

	/**
	 * Resolves to the identifying value of the SizeAdjustment provided during
	 * construction of the FixedSizeFormula. The given PlayerCharacter and
	 * source are ignored.
	 * 
	 * @param pc
	 *            The PlayerCharacter relative to which the FixedSizeFormula
	 *            should be resolved (ignored)
	 * @param source
	 *            The source object of the FixedSizeFormula, for purposes of
	 *            resolution (ignored)