/*
 * Copyright 2008 (C) Thomas Parker <thpr@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
 */
package plugin.lsttokens.campaign;

import pcgen.cdom.enumeration.ObjectKey;
import pcgen.core.Campaign;
import pcgen.rules.context.LoadContext;
import pcgen.rules.persistence.token.AbstractNonEmptyToken;
import pcgen.rules.persistence.token.CDOMPrimaryToken;
import pcgen.rules.persistence.token.ParseResult;
import pcgen.util.Logging;

/**
 * Class deals with SHOWINMENU Token
 */
public class ShowinmenuToken extends AbstractNonEmptyToken<Campaign> implements
		CDOMPrimaryToken<Campaign>
{

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

	@Override
	protected ParseResult parseNonEmptyToken(LoadContext context, Campaign campaign,
		String value)
	{
		Boolean set;
		char firstChar = value.charAt(0);
		if (firstChar == 'y' || firstChar == 'Y')
		{
			if (value.length() > 1 && !value.equalsIgnoreCase("YES"))
			{
				return new ParseResult.Fail("You should use 'YES' as the "
						+ getTokenName() + ": " + value, context);
			}
			set = Boolean.TRUE;
		}
		else if (Boolean.valueOf(value).booleanValue())
		{
			Logging.deprecationPrint("You should use 'YES' as the "
				+ getTokenName() + ": " + value + " in " + campaign.toString(), context);
			set = Boolean.TRUE;
		}
		else if ("false".equalsIgnoreCase(value))
		{
			Logging.deprecationPrint("You should use 'NO' as the "
				+ getTokenName() + ": " + value + " in " + campaign.toString(), context);
			set = Boolean.FALSE;
		}
		else
		{
			if (firstChar != 'N' && firstChar != 'n')
			{
				return new ParseResult.Fail("You should use 'YES' or 'NO' as the "
						+ getTokenName() + ": " + value, context);
			}
			if (value.length() > 1 && !value.equalsIgnoreCase("NO"))
			{
				return new ParseResult.Fail("You should use 'YES' or 'NO' as the "
						+ getTokenName() + ": " + value, context);
			}
			set = Boolean.FALSE;
		}
		context.getObjectContext().put(campaign, ObjectKey.SHOW_IN_MENU, set);
		return ParseResult.SUCCESS;
	}

    @Override
	public String[] unparse(LoadContext context, Campaign campaign)
	{
		Boolean isM = context.getObjectContext().getObject(campaign,
				ObjectKey.SHOW_IN_MENU);
		if (isM == null)
		{
			return null;
		}
		return new String[] { isM.booleanValue() ? "YES" : "NO" };
	}

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