/*
 * 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.IntegerKey;
import pcgen.cdom.util.CControl;
import pcgen.cdom.util.ControlUtilities;
import pcgen.core.Equipment;
import pcgen.rules.context.LoadContext;
import pcgen.rules.persistence.token.AbstractIntToken;
import pcgen.rules.persistence.token.CDOMPrimaryToken;
import pcgen.rules.persistence.token.ParseResult;

/**
 * Deals with REACHMULT token
 */
public class ReachMultToken extends AbstractIntToken<Equipment> implements
		CDOMPrimaryToken<Equipment>
{
	@Override
	public String getTokenName()
	{
		return "REACHMULT";
	}

	@Override
	protected IntegerKey integerKey()
	{
		return IntegerKey.REACH_MULT;
	}

	@Override
	protected int minValue()
	{
		return 1;
	}

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

	@Override
	public ParseResult parseToken(LoadContext context, Equipment obj, String value)
	{
		if (ControlUtilities.hasControlToken(context, CControl.EQREACH))
		{
			return new ParseResult.Fail(getTokenName()
				+ " is disabled when EQREACH control is used: " + value,
				context);
		}
		return super.parseToken(context, obj, value);
	}
}