PageUsageToken.java

/*
 * PageUsageToken.java
 * Copyright 2006 (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 Feb 22, 2006
 *
 * $Id$
 *
 */
package plugin.lsttokens.equipment;

import pcgen.base.formula.Formula;
import pcgen.cdom.base.FormulaFactory;
import pcgen.cdom.enumeration.FormulaKey;
import pcgen.core.Equipment;
import pcgen.rules.context.LoadContext;
import pcgen.rules.persistence.token.AbstractNonEmptyToken;
import pcgen.rules.persistence.token.CDOMPrimaryToken;
import pcgen.rules.persistence.token.ParseResult;

/**
 * {@code PageUsageToken} deals with PAGEUSAGE token
 * 
 * (Tue, 14 Mar 2006) $
 * 
 * @author James Dempsey <jdempsey@users.sourceforge.net>
 */
public class PageUsageToken extends AbstractNonEmptyToken<Equipment> implements
		CDOMPrimaryToken<Equipment>
{

	/**
	 * @see pcgen.persistence.lst.LstToken#getTokenName()
	 */
	@Override
	public String getTokenName()
	{
		return "PAGEUSAGE";
	}

	@Override
	protected ParseResult parseNonEmptyToken(LoadContext context,
		Equipment eq, String value)
	{
		Formula formula = FormulaFactory.getFormulaFor(value);
		if (!formula.isValid())
		{
			return new ParseResult.Fail("Formula in " + getTokenName()
					+ " was not valid: " + formula.toString(), context);
		}
		context.getObjectContext().put(eq, FormulaKey.PAGE_USAGE, formula);
		return ParseResult.SUCCESS;
	}

	@Override
	public String[] unparse(LoadContext context, Equipment eq)
	{
		Formula f = context.getObjectContext().getFormula(eq,
				FormulaKey.PAGE_USAGE);
		if (f == null)
		{
			return null;
		}
		return new String[] { f.toString() };
	}

	@Override
	public Class<Equipment> getTokenClass()
	{
		return Equipment.class;
	}
}