| /* |
| * Copyright (c) 2003 The Visigoth Software Society. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, if |
| * any, must include the following acknowledgement: |
| * "This product includes software developed by the |
| * Visigoth Software Society (http://www.visigoths.org/)." |
| * Alternately, this acknowledgement may appear in the software itself, |
| * if and wherever such third-party acknowledgements normally appear. |
| * |
| * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the |
| * project contributors may be used to endorse or promote products derived |
| * from this software without prior written permission. For written |
| * permission, please contact visigoths@visigoths.org. |
| * |
| * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth" |
| * nor may "FreeMarker" or "Visigoth" appear in their names |
| * without prior written permission of the Visigoth Software Society. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Visigoth Software Society. For more |
| * information on the Visigoth Software Society, please see |
| * http://www.visigoths.org/ |
| */ |
| |
| /* |
| * 22 October 1999: This class added by Holger Arendt. |
| */ |
| |
| package freemarker.template; |
| |
| import java.util.List; |
| |
| import freemarker.core.Environment; |
| |
| /** |
| * "method" template language data type: Objects that act like functions. The name comes from that their original |
| * application was calling Java methods via {@link freemarker.ext.beans.BeansWrapper}. |
| * |
| * <p>In templates they are used like {@code myMethod("foo", "bar")} or {@code myJavaObject.myJavaMethod("foo", "bar")}. |
| * |
| * @deprecated Use {@link TemplateMethodModelEx} instead. This interface is from the old times when the only kind of |
| * value you could pass in was string. |
| */ |
| public interface TemplateMethodModel extends TemplateModel { |
| |
| /** |
| * Executes the method call. All arguments passed to the method call are |
| * coerced to strings before being passed, if the FreeMarker rules allow |
| * the coercion. If some of the passed arguments can not be coerced to a |
| * string, an exception will be raised in the engine and the method will |
| * not be called. If your method would like to act on actual data model |
| * objects instead of on their string representations, implement the |
| * {@link TemplateMethodModelEx} instead. |
| * |
| * @param arguments a <tt>List</tt> of <tt>String</tt> objects |
| * containing the values of the arguments passed to the method. |
| * |
| * @return the return value of the method, or {@code null}. If the returned value |
| * does not implement {@link TemplateModel}, it will be automatically |
| * wrapped using the {@link Environment#getObjectWrapper() environment |
| * object wrapper}. |
| */ |
| public Object exec(List arguments) throws TemplateModelException; |
| } |