Class CNAbility

code/src/java/pcgen/cdom/content/CNAbility.java:41–223

An CNAbility represents an "unresolved" (categorized) Ability & Nature.

 * An CNAbility represents an "unresolved" (categorized) Ability & Nature.
 */
public class CNAbility extends ConcretePrereqObject
		implements QualifyingObject, Comparable<CNAbility>, ChooseDriver, Reducible
{

	private final Category<Ability> category;

	/**
	 * The Ability that this CNAbility represents
	 */
	private final Ability ability;

	/**
	 * The Nature of the Ability
	 */
	private final Nature nature;

	/**
	 * Creates a new CNAbility for the given Ability.
	 * 
	 * @param abil
	 *            The Ability which this CNAbility will contain
	 * @param nat
	 *            The Nature of the given Ability
	 */
	CNAbility(Category<Ability> cat, Ability abil, Nature nat)
	{
		Objects.requireNonNull(cat, "Cannot build CNAbility with null Category");
		Objects.requireNonNull(abil, "Cannot build CNAbility with null Ability");
		Objects.requireNonNull(nat, "Cannot build CNAbility with null Nature");
		if (abil.getKeyName() == null || abil.getKeyName().isEmpty())
		{
			throw new IllegalArgumentException("Cannot build CNAbility when Ability has no key");
		}
		Category<Ability> origCategory = abil.getCDOMCategory();
		if (origCategory == null)
		{
			throw new IllegalArgumentException(
				"Cannot build CNAbility for " + abil + " when Ability has null original Category");
		}
		if (!cat.getParentCategory().equals(origCategory))
		{
			throw new IllegalArgumentException("Cannot build CNAbility for " + abil + " with incompatible Category: "
				+ cat + " is not compatible with Ability's Category: " + origCategory);
		}
		category = cat;
		ability = abil;
		nature = nat;
	}

	/**
	 * Returns the key for the Ability in this CNAbility.
	 * 
	 * @return The key for the Ability in this CNAbility.
	 */
	public String getAbilityKey()
	{
		return ability.getKeyName();
	}