Class FollowerOption

code/src/java/pcgen/core/FollowerOption.java:38–150

This class represents a possible choice for a follower. This is basically a Race with a "FOLLOWERADJUSTMENT" that modifies the owner's effective level when selecting a follower of this type. Prereqs can also be specified

 * when selecting a follower of this type. Prereqs can also be specified
 */
public class FollowerOption extends ConcretePrereqObject implements Comparable<FollowerOption>, QualifyingObject
{
	private int theAdjustment = 0;
	private final CDOMReference<Race> ref;
	private final CDOMSingleRef<CompanionList> list;

	public FollowerOption(CDOMReference<Race> race, CDOMSingleRef<CompanionList> listref)
	{
		Objects.requireNonNull(race, "Cannot have FollowerOption with null race");
		Objects.requireNonNull(listref, "Cannot have FollowerOption with null list reference");
		ref = race;
		list = listref;
	}

	/**
	 * Returns the race associated with this option. If this option represents a
	 * group of races this method will return null.
	 * 
	 * @return The Race associated or null
	 */
	public Race getRace()
	{
		Collection<Race> races = ref.getContainedObjects();
		return races.size() == 1 ? races.iterator().next() : null;
	}

	public CDOMReference<Race> getRaceRef()
	{
		return ref;
	}

	/**
	 * Sets the variable adjustment for a master selecting this option. For
	 * example an adjustment of -3 would mean the master's level would be 3
	 * lower for purposes of applying companion mods.
	 * 
	 * @param anAdjustment
	 *            Amount to modify the master's level by
	 */
	public void setAdjustment(final int anAdjustment)
	{
		theAdjustment = anAdjustment;
	}

	/**
	 * Returns the adjustment to the master's level for this option.
	 * 
	 * @return The adjustment to the master's level
	 */
	public int getAdjustment()
	{
		return theAdjustment;
	}

	/**
	 * This method is overridden to also check that a master has enough
	 * effective levels to have a positive level after applying any adjustment
	 * for this follower. For example, if a follower has an adjustment of -3