View Javadoc

1   package org.apache.velocity.app.event.implement;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.    
20   */
21  
22  import org.apache.commons.lang.StringEscapeUtils;
23  
24  /**
25   * Escape all HTML entities.
26   * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeHtml(java.lang.String)">StringEscapeUtils</a>
27   * @author wglass
28   */
29  public class EscapeHtmlReference extends EscapeReference
30  {
31  
32      /**
33       * Escape all HTML entities.
34       * 
35       * @param text
36       * @return An escaped String.
37       * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeHtml(java.lang.String)">StringEscapeUtils</a>
38       */
39      protected String escape(Object text)
40      {
41          return StringEscapeUtils.escapeHtml(text.toString());
42      }
43  
44      /**
45       * @return attribute "eventhandler.escape.html.match"
46       */
47      protected String getMatchAttribute()
48      {
49          return "eventhandler.escape.html.match";
50      }
51  
52  }