InfoSheetToken.java

/*
 * InfoSheetToken.java
 * Copyright 2010 (C) James Dempsey
 *
 * 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 30/05/2010 10:00:00 PM
 *
 * $Id$
 */
package plugin.lsttokens.gamemode;

import java.net.URI;

import pcgen.cdom.base.Constants;
import pcgen.core.GameMode;
import pcgen.persistence.lst.GameModeLstToken;
import pcgen.util.Logging;

/**
 * This class handles the INFOSHEET game mode token. The token allows a 
 * game mode specific information output sheet to be specified that will be 
 * displayed on the summary tab when editing a character. 
 *
 * <br>
 * 
 * @author James Dempsey <jdempsey@users.sourceforge.net>
 */
public class InfoSheetToken implements GameModeLstToken
{

	/* (non-Javadoc)
	 * @see pcgen.persistence.lst.GameModeLstToken#parse(pcgen.core.GameMode, java.lang.String, java.net.URI)
	 */
    @Override
	public boolean parse(GameMode gameMode, String value, URI source)
	{
		String[] tokens = value.split("\\|");
		
		if (tokens.length != 2)
		{
			Logging.log(Logging.LST_ERROR, "Invalid token " + getTokenName()
				+ Constants.COLON + value
				+ ". Expected INFOSHEET:SUMMARY|x or INFOSHEET:SKILL|x "
				+ " in " + source.toString());
			return false;
		}
		if (tokens[0].equals("SUMMARY"))
		{
			gameMode.setInfoSheet(tokens[1]);
		}
		else if (tokens[0].equals("SKILLS"))
		{
			gameMode.setInfoSheetSkill(tokens[1]);
		}
		else
		{
			Logging.log(Logging.LST_ERROR, "Invalid token " + getTokenName()
				+ Constants.COLON + value
				+ ". Expected INFOSHEET:SUMMARY|x or INFOSHEET:SKILL|x "
				+ " in " + source.toString());
			return false;
		}
			
		return true;
	}

	/**
	 * Returns the name of the token this class handles.
	 * 
	 * @see pcgen.persistence.lst.LstToken#getTokenName()
	 */
    @Override
	public String getTokenName()
	{
		return "INFOSHEET"; //$NON-NLS-1$
	}

}