/*
 * Copyright (c) 2008 Tom Parker <thpr@users.sourceforge.net>
 * 
 * This program 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 program 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
package plugin.lsttokens.equipment;

import pcgen.cdom.enumeration.EqModControl;
import pcgen.cdom.enumeration.ObjectKey;
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;

/**
 * Deals with MODS token
 */
public class ModsToken extends AbstractNonEmptyToken<Equipment> implements
		CDOMPrimaryToken<Equipment>
{

	@Override
	public String getTokenName()
	{
		return "MODS";
	}

	@Override
	protected ParseResult parseNonEmptyToken(LoadContext context,
		Equipment eq, String value)
	{
		EqModControl ctrl;
		try
		{
			ctrl = EqModControl.valueOf(value);
		}
		catch (IllegalArgumentException iae)
		{
			return new ParseResult.Fail("Invalid Mod Control provided in "
					+ getTokenName() + ": " + value, context);
		}
		context.getObjectContext().put(eq, ObjectKey.MOD_CONTROL, ctrl);
		return ParseResult.SUCCESS;
	}

	@Override
	public String[] unparse(LoadContext context, Equipment eq)
	{
		EqModControl control = context.getObjectContext().getObject(eq,
				ObjectKey.MOD_CONTROL);
		if (control == null)
		{
			return null;
		}
		return new String[] { control.toString() };
	}

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