Class EquipNode

code/src/java/pcgen/gui2/facade/EquipNode.java:37–238

The Class EquipNodeImpl represents a node in the equipping tree. It may be an item of equipment or a slot that may be filled. EquipNodeImpl objects are immutable.

 * EquipNodeImpl objects are immutable.
 */
public class EquipNode implements Comparable<EquipNode>
{
	public static enum NodeType
	{
		/** This is a body location which can contain other slots rather 
		 * than equipment. */
		BODY_SLOT,
	
		/** This is a node which shows an empty slot that takes a specific 
		 * equipment type (e.g. Ring). It is removed from the tree when the 
		 * slot it represents is full and added back in when there is space 
		 * in the slot. */
		PHANTOM_SLOT,
	
		/** This is a node representing an equipped item of equipment. */
		EQUIPMENT
	}

	private static final NumberFormat FMT = new DecimalFormat("00");
	private final NodeType nodeType;
	private final BodyStructure bodyStructure;
	private Equipment equipment;
	EquipNode parent;
	private final String name;
	private EquipSlot slot;
	String idPath;
	private String order;
	boolean singleOnly = false;

	/**
	 * Create a new EquipNodeImpl instance representing a body structure.
	 *
	 * @param bodyStructure The part of the body.
	 * @param order The order of the body structure
	 */
	public EquipNode(BodyStructure bodyStructure, int order)
	{
		this.nodeType = NodeType.BODY_SLOT;
		this.bodyStructure = bodyStructure;
		this.name = bodyStructure.toString();
		this.order = FMT.format(order);
	}

	/**
	 * Create a new EquipNodeImpl instance representing an equipment slot.
	 * These are called phantom slots as they represent a location yet to
	 * be filled.
	 *
	 * @param parent The parent body structure node
	 * @param slot The equipment slot
	 * @param singleOnly Can the slot only ever have a single entry. e.g. weapon slots
	 */
	public EquipNode(EquipNode parent, EquipSlot slot, boolean singleOnly)
	{
		this.nodeType = NodeType.PHANTOM_SLOT;
		this.bodyStructure = parent.bodyStructure;
		this.slot = slot;
		this.name = slot.getSlotName();