a wrapper class for the StringUtil.encodeHTML method that implements the freemarker...
[mir.git] / source / mir / misc / EncodeHTMLMethodModel.java
1 /*
2  * Copyright (C) 2001, 2002  The Mir-coders group
3  *
4  * This file is part of Mir.
5  *
6  * Mir is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Mir is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Mir; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * In addition, as a special exception, The Mir-coders gives permission to link
21  * the code of this program with the com.oreilly.servlet library, any library
22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
24  * the above that use the same license as the above), and distribute linked
25  * combinations including the two.  You must obey the GNU General Public
26  * License in all respects for all of the code used other than the above
27  * mentioned libraries.  If you modify this file, you may extend this exception
28  * to your version of the file, but you are not obligated to do so.  If you do
29  * not wish to do so, delete this exception statement from your version.
30  */
31
32 package  mir.misc;
33
34 import freemarker.template.*;
35
36 import java.util.List;
37
38 /**
39  * Wrapper class that implements the freemarker template model for the
40  * StringUtil.encodeHTML method.
41  *
42  * @version $Id: EncodeHTMLMethodModel.java,v 1.1.2.1 2002/12/10 09:10:41 mh Exp $
43  * @author mh, Mir-coders group
44  *
45  */
46
47 public class EncodeHTMLMethodModel implements TemplateMethodModel
48 {
49   public TemplateModel exec(List arguments) throws TemplateModelException {
50     if (arguments.size()==1) {
51       try {
52         String aString = StringUtil.interpretAsString(arguments.get(0));
53         return new SimpleScalar(StringUtil.encodeHTML(aString));
54       } catch (Exception e) {
55         throw new TemplateModelException("EncodeHTMLTemplateMethodModel: "+e.getMessage());
56       }
57     } else {
58       throw new TemplateModelException("EncodeHTMLTemplateMethodModel: argument list empty or null!");
59     }
60   }
61
62   // who knows..... -mh
63   public boolean isEmpty() {
64     return false;
65   }
66 }
67