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 XML entities.
26   * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeSql(java.lang.String)">StringEscapeUtils</a>
27   * @author wglass
28   * @since 1.5
29   */
30  public class EscapeXmlReference extends EscapeReference
31  {
32  
33      /**
34       * Escape all XML entities.
35       * 
36       * @param text
37       * @return An escaped String.
38       * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeSql(java.lang.String)">StringEscapeUtils</a>
39       */
40      protected String escape(Object text)
41      {
42          return StringEscapeUtils.escapeXml(text.toString());
43      }
44  
45      /**
46       * @return attribute "eventhandler.escape.xml.match"
47       */
48      protected String getMatchAttribute()
49      {
50          return "eventhandler.escape.xml.match";
51      }
52  
53  }