SpellListKnownToken.java

/*
 * SpellListKnownToken.java
 * Copyright 2004 (C) James Dempsey <jdempsey@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
 *
 * Created on Jul 15, 2004
 *
 * $Id$
 *
 */
package plugin.exporttokens;

import pcgen.cdom.base.CDOMObject;
import pcgen.core.PCClass;
import pcgen.core.PlayerCharacter;
import pcgen.io.ExportHandler;
import pcgen.io.exporttoken.SpellListToken;

/**
 * {@code SpellListKnownToken} outputs the number of spells you
 * can know for the specified spellcaster class and level. For Clerics 
 * with domains, this does not include domain spells.
 *
 *
 * @author James Dempsey <jdempsey@users.sourceforge.net>
 */

public class SpellListKnownToken extends SpellListToken
{

	/** Token name */
	public static final String TOKENNAME = "SPELLLISTKNOWN";

	/**
	 * @see pcgen.io.exporttoken.Token#getTokenName()
	 */
	@Override
	public String getTokenName()
	{
		return TOKENNAME;
	}

	/**
	 * @see pcgen.io.exporttoken.Token#getToken(java.lang.String, pcgen.core.PlayerCharacter, pcgen.io.ExportHandler)
	 */
	@Override
	public String getToken(String tokenSource, PlayerCharacter pc,
		ExportHandler eh)
	{
		StringBuilder retValue = new StringBuilder();

		SpellListTokenParams params =
				new SpellListTokenParams(tokenSource,
					SpellListToken.SPELLTAG_KNOWN);

		final CDOMObject aObject = pc.getSpellClassAtIndex(params.getClassNum());

		if (aObject != null)
		{
			retValue.append(Integer.toString(getKnownNum(aObject, params
				.getLevel(), pc)));
		}

		return retValue.toString();
	}

	/**
	 * Retrieve the number of spells the pc may know of the specified 
	 * level of the supplied class.
	 * 
	 * @param aObject The class
	 * @param level The spell level
	 * @param pc The character being queried
	 * @return The number of spells allowed to be known.
	 */
	private int getKnownNum(CDOMObject aObject, int level, PlayerCharacter pc)
	{
		int knownNum = 0;

		if (aObject instanceof PCClass)
		{
			PCClass aClass = (PCClass) aObject;
			knownNum = pc.getSpellSupport(aClass).getKnownForLevel(level, pc);
		}

		return knownNum;
	}

}