Class CDOMSingleRef

code/src/java/pcgen/cdom/reference/CDOMSingleRef.java:30–87

A CDOMSingleRef is a CDOMReference which is intended to contain a single object of a given Type for the Class this CDOMSingleRef represents. @param The Class of the underlying object contained by this CDOMSingleRef

 *            The Class of the underlying object contained by this CDOMSingleRef
 */
public abstract class CDOMSingleRef<T> extends CDOMReference<T> implements Indirect<T>
{

	/**
	 * Constructs a new CDOMSingleRef for the given name.
	 * 
	 * @param key
	 *            An identifier of the object this CDOMSingleRef contains.
	 */
	public CDOMSingleRef(String key)
	{
		super(key);
	}

	/**
	 * Returns one: The count of the number of objects included in the
	 * Collection of Objects to which this CDOMSingleRef refers.
	 * 
	 * @return one (since this is a single reference)
	 */
	@Override
	public int getObjectCount()
	{
		return 1;
	}

	/**
	 * Returns the given Object this CDOMSingleRef contains.
	 * 
	 * Note that the behavior of this class is undefined if the CDOMSingleRef
	 * has not yet been resolved.
	 * 
	 * @return the given Object this CDOMSingleRef contains.
	 */
	@Override
	public abstract T get();

	/**
	 * Returns true if this CDOMSingleRef has been resolved; false otherwise.
	 * 
	 * @return true if this CDOMSingleRef has been resolved; false otherwise
	 */
	public abstract boolean hasBeenResolved();

	/**
	 * Sets the choice for this CDOMSingleRef.
	 * 
	 * @param choice The choice to be set for this CDOMSingleRef
	 */
	public abstract void setChoice(String choice);

	@Override
	public String getUnconverted()
	{
		return getName();
	}

}