/*
 * 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.campaign;

import java.net.URI;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import pcgen.cdom.enumeration.ListKey;
import pcgen.core.Campaign;
import pcgen.persistence.lst.InstallLstToken;
import pcgen.rules.context.Changes;
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 INFOTEXT Token
 */
public class InfotextToken extends AbstractNonEmptyToken<Campaign> implements
		CDOMPrimaryToken<Campaign>, InstallLstToken
{

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

    @Override
	public boolean parse(Campaign campaign, String value, URI sourceUri)
	{
		campaign.addToListFor(ListKey.INFO_TEXT, value);
		return true;
	}

	@Override
	protected ParseResult parseNonEmptyToken(LoadContext context, Campaign campaign,
		String value)
	{
		context.getObjectContext().addToList(campaign, ListKey.INFO_TEXT, value);
		return ParseResult.SUCCESS;
	}

    @Override
	public String[] unparse(LoadContext context, Campaign campaign)
	{
		Changes<String> changes =
				context.getObjectContext().getListChanges(campaign,
					ListKey.INFO_TEXT);
		List<String> set = new ArrayList<>();
		Collection<String> added = changes.getAdded();
		if (added != null && !added.isEmpty())
		{
			set.addAll(added);
		}
		if (set.isEmpty())
		{
			//Okay, no info text
			return null;
		}
		return set.toArray(new String[set.size()]);
	}

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