01: /*
02: * Copyright (c) 2003 The Visigoth Software Society. All rights
03: * reserved.
04: *
05: * Redistribution and use in source and binary forms, with or without
06: * modification, are permitted provided that the following conditions
07: * are met:
08: *
09: * 1. Redistributions of source code must retain the above copyright
10: * notice, this list of conditions and the following disclaimer.
11: *
12: * 2. Redistributions in binary form must reproduce the above copyright
13: * notice, this list of conditions and the following disclaimer in
14: * the documentation and/or other materials provided with the
15: * distribution.
16: *
17: * 3. The end-user documentation included with the redistribution, if
18: * any, must include the following acknowledgement:
19: * "This product includes software developed by the
20: * Visigoth Software Society (http://www.visigoths.org/)."
21: * Alternately, this acknowledgement may appear in the software itself,
22: * if and wherever such third-party acknowledgements normally appear.
23: *
24: * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
25: * project contributors may be used to endorse or promote products derived
26: * from this software without prior written permission. For written
27: * permission, please contact visigoths@visigoths.org.
28: *
29: * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
30: * nor may "FreeMarker" or "Visigoth" appear in their names
31: * without prior written permission of the Visigoth Software Society.
32: *
33: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36: * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
37: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
40: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
41: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44: * SUCH DAMAGE.
45: * ====================================================================
46: *
47: * This software consists of voluntary contributions made by many
48: * individuals on behalf of the Visigoth Software Society. For more
49: * information on the Visigoth Software Society, please see
50: * http://www.visigoths.org/
51: */
52:
53: /*
54: * 22 October 1999: This class added by Holger Arendt.
55: */
56:
57: package freemarker.template;
58:
59: import java.util.List;
60:
61: /**
62: * Objects that act as methods in a template data model must implement this
63: * interface.
64: *
65: * <P>Implementions of <tt>TemplateMethodModel</tt> should be thread-safe.
66: *
67: * @version $Id: TemplateMethodModel.java,v 1.11 2003/09/22 23:56:54 revusky Exp $
68: */
69: public interface TemplateMethodModel extends TemplateModel {
70:
71: /**
72: * Executes a method call. All arguments passed to the method call are
73: * treated as {@link TemplateScalarModel}s, and evaluated to Strings
74: * before being passed. If some of the passed arguments is not a scalar,
75: * an exception will occur and the method will not be called.
76: * If your method would like to act on actual data model objects instead
77: * of on their String representations, implement the
78: * {@link TemplateMethodModelEx} instead.
79: * @param arguments a <tt>List</tt> of <tt>String</tt> objects
80: * containing the values of the arguments passed to the method.
81: * @return the <tt>TemplateModel</tt> produced by the method, or null.
82: */
83: public Object exec(List arguments) throws TemplateModelException;
84: }
|