Class ClassFacet

code/src/java/pcgen/cdom/facet/model/ClassFacet.java:46–825

ClassFacet is a Facet that tracks the PCClass objects possessed by a Player Character.

 *
 */
public class ClassFacet extends AbstractDataFacet<CharID, PCClass> implements SetFacet<CharID, PCClass>
{
	private final ClassLevelChangeSupport support = new ClassLevelChangeSupport();

	/**
	 * Add the given PCClass to the list of PCClass objects stored in this
	 * ClassFacet for the Player Character represented by the given CharID.
	 *
	 * @param id
	 *            The CharID representing the Player Character for which the
	 *            given PCClass should be added
	 * @param obj
	 *            The PCClass to be added to the list of PCClass objects stored
	 *            in this AbstractListFacet for the Player Character represented
	 *            by the given CharID
	 */
	public void addClass(CharID id, PCClass obj)
	{
		Objects.requireNonNull(obj, "PCClass to add may not be null");
		if (getConstructingClassInfo(id).addClass(obj))
		{
			fireDataFacetChangeEvent(id, obj, DataFacetChangeEvent.DATA_ADDED);
		}
	}

	/**
	 * Sets the PCClassLevel object associated with the given PCClass for the Player
	 * Character represented by the given CharID. Returns true if the set is successful.
	 * The set will be successful if the given PCClass is possessed by the given
	 * PlayerCharacter; false otherwise.
	 *
	 * The (numeric) class level for which the given PCClassLevel should be applied is
	 * determined by the level value set in the PCClassLevel.
	 *
	 * @param id
	 *            The CharID representing the Player Character for which the given
	 *            PCClassLevel should be set
	 * @param pcc
	 *            The PCClass object for which the PCClassLevel object is set as the
	 *            PCClass
	 * @param pcl
	 *            The PCClassLevel object to be associated with the given PCClass and
	 *            Player Character represented by the given CharID
	 * @return true if the set is successful; false otherwise.
	 * @throws CloneNotSupportedException
	 *             if the class level cannot be thrown
	 */
	public boolean setClassLevel(CharID id, PCClass pcc, PCClassLevel pcl) throws CloneNotSupportedException
	{
		Objects.requireNonNull(pcc, "Class cannot be null in setClassLevel");
		Objects.requireNonNull(pcl, "Class Level cannot be null in setClassLevel");
		ClassInfo info = getClassInfo(id);
		if (info == null)
		{
			return false;
		}
		PCClassLevel old = info.getClassLevel(pcc, pcl.get(IntegerKey.LEVEL));
		boolean returnVal = info.setClassLevel(pcc, pcl);