/*
 * Copyright (c) 2009 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.statsandchecks.alignment;

import pcgen.core.PCAlignment;
import pcgen.rules.context.LoadContext;
import pcgen.rules.persistence.token.AbstractNonEmptyToken;
import pcgen.rules.persistence.token.CDOMPrimaryToken;
import pcgen.rules.persistence.token.ParseResult;

/**
 * Class deals with ABB Token for pc alignment
 */
public class AbbToken extends AbstractNonEmptyToken<PCAlignment> implements
		CDOMPrimaryToken<PCAlignment>
{

	/**
	 * Return token name
	 *
	 * @return token name
	 */
	@Override
	public String getTokenName()
	{
		return "ABB";
	}

	@Override
	protected ParseResult parseNonEmptyToken(LoadContext context,
		PCAlignment al, String value)
	{
		/*
		 * Warning: RegisterAbbreviation is not editor friendly, and this is a
		 * gate to additional alignments being added in Campaigns (vs. Game
		 * Modes)
		 */
		context.getReferenceContext().registerAbbreviation(al, value);
		return ParseResult.SUCCESS;
	}

	@Override
	public String[] unparse(LoadContext context, PCAlignment al)
	{
		String abb = context.getReferenceContext().getAbbreviation(al);
		if (abb == null)
		{
			return null;
		}
		return new String[] { abb };
	}

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