/*
* Copyright 2007, 2008 (C) Tom Parker <thpr@users.sourceforge.net>
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package pcgen.cdom.base;
import java.util.Collection;
import pcgen.cdom.enumeration.GroupingState;
import pcgen.core.PlayerCharacter;
import pcgen.core.chooser.CDOMChoiceManager;
import pcgen.core.chooser.ChoiceManagerList;
import pcgen.rules.context.LoadContext;
/**
* This is a transitional class from PCGen 5.15+ to the final CDOM core. It is
* provided as convenience to hold a set of choices and the number of choices
* allowed, prior to final implementation of the new choice system.
*
* This is a TransitionChoice that is designed to be stored in a PlayerCharacter
* file when saved. Thus, encoding and decoding (to a 'persistent' string)
* methods are provided.
*
* @param <T>
*/
public class BasicChooseInformation<T> implements ChooseInformation<T>
{
/**
* The PrimitiveChoiceSet containing the Collection of Objects in this
* ChoiceSet
*/
private final PrimitiveChoiceSet<T> pcs;
/**
* The name of this ChoiceSet
*/
private final String setName;
/**
* The title (presented to the user) of this ChoiceSet
*/
private String title = null;
/**
* The PersistentChoiceActor (optional) which will act upon any choices made
* from this PersistentTransitionChoice.
*/
private Chooser<T> choiceActor;
/**
* Constructs a new TransitionChoice with the given ChoiceSet (of possible
* choices) and Formula (indicating the number of choices that may be taken)
*
* @param name
* The name of this ChoiceSet
* @param choice
* The PrimitiveChoiceSet indicating the Collection of objects
* for this ChoiceSet
* @throws IllegalArgumentException
* if the given name or PrimitiveChoiceSet is null
*/
public BasicChooseInformation(String name, PrimitiveChoiceSet<T> choice)
{
if (choice == null)
{
throw new IllegalArgumentException(
"PrimitiveChoiceSet cannot be null");
}
if (name == null)
{
throw new IllegalArgumentException("Name cannot be null");
}
pcs = choice;
setName = name;
}
/**
* Sets the (optional) ChoiceActor for this TransitionChoice. The
* ChoiceActor will be called when the act method of TransitionChoice is
* called. If the ChoiceActor is not set, then the set method may not be
* used without triggering an exception.
*
* @param actor
* The ChoiceActor for this TransitionChoice.
* @throws ClassCastException
* if the given ChoiceActor is not a PersistentChoiceActor
*/
@Override
public void setChoiceActor(Chooser<T> actor)
{
choiceActor = actor;
}
/**
* Encodes the given choice into a String sufficient to uniquely identify
* the choice. This may not sufficiently encode to be stored into a file or
* format which restricts certain characters (such as URLs), it simply
* encodes into an identifying String. There is no guarantee that this
* encoding is human readable, simply that the encoding is uniquely
* identifying such that the decodeChoice method of the
* PersistentTransitionChoice is capable of decoding the String into the
* choice object.
*
* @param item
* The choice which should be encoded into a String sufficient to
* identify the choice.
*
* @return A String sufficient to uniquely identify the choice.
*/
@Override
public String encodeChoice(T item)
{
return choiceActor.encodeChoice(item);
}
/**
* Decodes a given String into a choice of the appropriate type. The String
* format to be passed into this method is defined solely by the return
* result of the encodeChoice method. There is no guarantee that the
* encoding is human readable, simply that the encoding is uniquely
* identifying such that this method is capable of decoding the String into
* the choice object.
* @param persistenceFormat
* The String which should be decoded to provide the choice of
* the appropriate type.
*
* @return A choice object of the appropriate type that was encoded in the
* given String.
*/
@Override
public T decodeChoice(LoadContext context, String persistenceFormat)
{
return choiceActor.decodeChoice(context, persistenceFormat);
}
@Override
public Chooser<T> getChoiceActor()
{
return choiceActor;
}
/**
* Returns true if the given Object is a TransitionChoice and has identical
* underlying choices and choiceCount
*
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(Object obj)
{
if (obj instanceof BasicChooseInformation)
{
BasicChooseInformation<?> other = (BasicChooseInformation<?>) obj;
if (title == null)
{
if (other.title != null)
{
return false;
}
}
else if (!title.equals(other.title))
{
return false;
}
return setName.equals(other.setName) && pcs.equals(other.pcs);
}
return false;
}
/**
* Returns a consistent-with-equals hashCode for this TransitionChoice.
*
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode()
{
return setName.hashCode() + 29;
}
/**
* Returns a representation of this ChoiceSet, suitable for storing in an
* LST file.
*/
@Override
public String getLSTformat()
{
return pcs.getLSTformat(false);
}
/**
* Returns the Class contained within this ChoiceSet
*
* @return the Class contained within this ChoiceSet
*/
@Override
public ClassIdentity<? super T> getClassIdentity()
{
return BasicClassIdentity.getIdentity(pcs.getChoiceClass());
}
/**
* Returns a Set of objects contained within this ChoiceSet for the given
* PlayerCharacter.
*
* @param pc
* The PlayerCharacter for which the choices in this ChoiceSet
* should be returned.
* @return a Set of objects contained within this ChoiceSet for the given
* PlayerCharacter.
*/
@Override
public Collection<? extends T> getSet(PlayerCharacter pc)
{
return pcs.getSet(pc);
}
/**
* Returns the name of this ChoiceSet. Note that this name is suitable for
* display, but it does not represent information that should be stored in a
* persistent state (it is not sufficient information to reconstruct this
* ChoiceSet)
*
* @return The name of this ChoiceSet
*/
@Override
public String getName()
{
return setName;
}
/**
* Sets the title of this ChoiceSet. Note that this should be the name that
* is displayed to the user when a selection from this ChoiceSet is made,
* but it does not represent information that should be stored in a
* persistent state (it is not sufficient information to reconstruct this
* ChoiceSet)
*/
public void setTitle(String choiceTitle)
{
title = choiceTitle;
}
/**
* Returns the title of this ChoiceSet. Note that this should be the name
* that is displayed to the user when a selection from this ChoiceSet is
* made, but it does not represent information that should be stored in a
* persistent state (it is not sufficient information to reconstruct this
* ChoiceSet)
*
* @return The title of this ChoiceSet
*/
@Override
public String getTitle()
{
return title;
}
@Override
public GroupingState getGroupingState()
{
return pcs.getGroupingState();
}
@Override
public void restoreChoice(PlayerCharacter pc, ChooseDriver owner, T item)
{
choiceActor.restoreChoice(pc, owner, item);
}
@Override
public ChoiceManagerList<T> getChoiceManager(ChooseDriver owner, int cost)
{
return new CDOMChoiceManager<>(owner, this, null, cost);
}
@Override
public CharSequence composeDisplay(Collection<? extends T> collection)
{
return ChooseInformationUtilities.buildEncodedString(this, collection);
}
@Override
public void removeChoice(PlayerCharacter pc, ChooseDriver owner, T item)
{
choiceActor.removeChoice(pc, owner, item);
}
}