PCVarFunction.java

/*
 * PCVarFunction.java
 * Copyright 2013 (C) James Dempsey <jdempsey@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
 *
 * Created on 25/10/2013
 */
package pcgen.io.freemarker;

import java.util.List;

import pcgen.core.PlayerCharacter;
import freemarker.template.TemplateMethodModelEx;
import freemarker.template.TemplateModelException;

/**
 * PCVarFunction allows character variable values to be exported to a 
 * Freemarker template. It evaluates a variable for the current character and 
 * returns the value as a number. e.g. ${pcvar("CL=Fighter")} 
 * 
 * @author James Dempsey <jdempsey@users.sourceforge.net>
 */
public class PCVarFunction implements TemplateMethodModelEx
{
	private PlayerCharacter pc;

	/**
	 * Create a new instance of PCVarFunction
	 * @param pc The character being exported.
	 */
	public PCVarFunction(PlayerCharacter pc)
	{
		this.pc = pc;
	}

	@SuppressWarnings("rawtypes")
	@Override
	public Object exec(List arg0) throws TemplateModelException
	{
		if (arg0.size() != 1)
		{
			throw new TemplateModelException(
				"Wrong arguments. formula required");
		}

		String formula = arg0.get(0).toString();

		Float result = pc.getVariableValue(formula, "");
		return result;
	}

}