KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > taglibs > standard > lang > jpath > expression > EncodeHtmlFunction


1 /*
2  * Copyright 1999,2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package org.apache.taglibs.standard.lang.jpath.expression;
18
19 import javax.servlet.jsp.PageContext JavaDoc;
20
21 import org.apache.taglibs.standard.lang.jpath.adapter.ConversionException;
22 import org.apache.taglibs.standard.lang.jpath.adapter.Convert;
23 import org.apache.taglibs.standard.lang.jpath.adapter.IterationContext;
24 import org.apache.taglibs.standard.lang.jpath.encoding.HtmlEncoder;
25
26 /**
27  * The EncodeHtmlFunction class
28  *
29  *
30  * @author <a HREF='mailto:scott.hasse@isthmusgroup.com'>Scott Hasse</a>
31  * @version
32  */
33 public class EncodeHtmlFunction extends SimpleNode {
34
35     /**
36      * Used to create an instance of the EncodeHtmlFunction class
37      *
38      *
39      * @param id
40      *
41      */
42     public EncodeHtmlFunction(int id) {
43         super(id);
44     }
45
46     /**
47      * Used to create an instance of the EncodeHtmlFunction class
48      *
49      *
50      * @param p
51      * @param id
52      *
53      */
54     public EncodeHtmlFunction(Parser p, int id) {
55         super(p, id);
56     }
57
58     /**
59      * Provides a method to print a normalized version of the original
60      * expression. The normalized version has standardized spacing and
61      * parenthesis, and can be used to compare expressions formatted
62      * in different ways to see if they are actually the same expression.
63      *
64      *
65      * @return The normalized version of the original expression
66      *
67      */
68     public String JavaDoc toNormalizedString() {
69
70         String JavaDoc normalized = "";
71
72         normalized = "encode-html(" + jjtGetChild(0).toNormalizedString()
73                 + ")";
74
75         return normalized;
76     }
77
78     /**
79      * This method evaluates this node of the expression and all child nodes.
80      * It returns the result of the
81      * evaluation as an <tt>Object</tt>. If any problems are encountered
82      * during the evaluation, an <tt>EvaluationException</tt> is thrown.
83      *
84      *
85      * @param pageContext the current JSP PageContext
86      *
87      * @param icontext the Iteration Context of the expression. If there is
88      * no interation context, this should be null.
89      *
90      * @return the result of the expression evaluation as an object
91      *
92      * @throws EvaluationException if a problem is encountered during the
93      * evaluation
94      */
95     public Object JavaDoc evaluate(PageContext JavaDoc pageContext, IterationContext icontext)
96             throws EvaluationException {
97
98         String JavaDoc result;
99
100         try {
101             result =
102                 HtmlEncoder
103                     .encode(Convert
104                         .toString(jjtGetChild(0)
105                             .evaluate(pageContext, icontext)));
106         } catch (ConversionException ce) {
107             throw new EvaluationException(this, ce.getMessage());
108         }
109
110         return result;
111     }
112 }
113
Popular Tags