/*
 * Copyright (c) 2007 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.testsupport;

import org.junit.Test;

import pcgen.cdom.base.CDOMObject;
import pcgen.cdom.base.CDOMReference;
import pcgen.cdom.enumeration.ListKey;
import pcgen.cdom.reference.CDOMDirectSingleRef;
import pcgen.cdom.reference.CDOMGroupRef;
import pcgen.persistence.PersistenceLayerException;

public abstract class AbstractListKeyTokenTestCase<T extends CDOMObject, TC extends CDOMObject>
		extends AbstractListInputTokenTestCase<T, TC>
{

	protected abstract ListKey<CDOMReference<TC>> getListKey();

	@Test
	public void testUnparseNull() throws PersistenceLayerException
	{
		primaryProf.removeListFor(getListKey());
		assertNull(getToken().unparse(primaryContext, primaryProf));
	}

	@Test
	public void testUnparseSingle() throws PersistenceLayerException
	{
		TC wp1 = construct(primaryContext, "TestWP1");
		addToList(CDOMDirectSingleRef.getRef(wp1));
		String[] unparsed = getToken().unparse(primaryContext, primaryProf);
		expectSingle(unparsed, "TestWP1");
	}

	@Test
	public void testUnparseMultiple() throws PersistenceLayerException
	{
		TC wp1 = construct(primaryContext, "TestWP1");
		addToList(CDOMDirectSingleRef.getRef(wp1));
		TC wp2 = construct(primaryContext, "TestWP2");
		addToList(CDOMDirectSingleRef.getRef(wp2));
		String[] unparsed = getToken().unparse(primaryContext, primaryProf);
		expectSingle(unparsed, "TestWP1" + getJoinCharacter() + "TestWP2");
	}

	/*
	 * TODO This needs to be tested, but this token does not consolidate. This
	 * is therefore untested in super.testRoundRobinThreeDupe()
	 */
	// @Test
	// public void testUnparseDupe() throws PersistenceLayerException
	// {
	// if (allowDups())
	// {
	// TC wp1 = construct(primaryContext, "TestWP1");
	// addToList(CDOMDirectSingleRef.getRef(wp1));
	// addToList(CDOMDirectSingleRef.getRef(wp1));
	// String[] unparsed = getToken().unparse(primaryContext, primaryProf);
	// expectSingle(unparsed, "TestWP1" + getJoinCharacter() + "TestWP1");
	// }
	// else
	// {
	// TC wp1 = construct(primaryContext, "TestWP1");
	// addToList(CDOMDirectSingleRef.getRef(wp1));
	// addToList(CDOMDirectSingleRef.getRef(wp1));
	// String[] unparsed = getToken().unparse(primaryContext, primaryProf);
	// expectSingle(unparsed, "TestWP1");
	// }
	// }

	@Test
	public void testUnparseNullInList() throws PersistenceLayerException
	{
		addToList(null);
		try
		{
			getToken().unparse(primaryContext, primaryProf);
			fail();
		}
		catch (NullPointerException e)
		{
			// Yep!
		}
	}

	@Test
	public void testUnparseType() throws PersistenceLayerException
	{
		if (isTypeLegal())
		{
			CDOMGroupRef<TC> tr = getTypeReference();
			addToList(tr);
			String[] unparsed = getToken().unparse(primaryContext, primaryProf);
			expectSingle(unparsed, tr.getLSTformat(false));
		}
	}

	protected CDOMGroupRef<TC> getTypeReference()
	{
		return primaryContext.getReferenceContext().getCDOMTypeReference(getTargetClass(),
				"Type1");
	}

	@Test
	public void testUnparseAll() throws PersistenceLayerException
	{
		if (isTypeLegal())
		{
			CDOMGroupRef<TC> allReference = getAllReference();
			addToList(allReference);
			String[] unparsed = getToken().unparse(primaryContext, primaryProf);
			expectSingle(unparsed, getAllString());
		}
	}

	protected CDOMGroupRef<TC> getAllReference()
	{
		return primaryContext.getReferenceContext().getCDOMAllReference(getTargetClass());
	}

	/*
	 * TODO Need to figure out who owns this responsibility
	 */
	// @Test
	// public void testUnparseGenericsFail() throws PersistenceLayerException
	// {
	// ListKey listKey = getListKey();
	// primaryProf.addToListFor(listKey, new Object());
	// try
	// {
	// String[] unparsed = getToken().unparse(primaryContext, primaryProf);
	// fail();
	// }
	// catch (ClassCastException e)
	// {
	// // Yep!
	// }
	// }
	protected void addToList(CDOMReference<TC> val)
	{
		primaryProf.addToListFor(getListKey(), val);
	}
}