org.apache.velocity.app.event.implement.EscapeXmlReference Maven / Gradle / Ivy
The newest version!
package org.apache.velocity.app.event.implement;
import org.apache.commons.lang3.StringEscapeUtils;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Escape all XML entities, suitable for placing the output inside an XML (1.0) text node or attribute value.
* Warning: escaping references this way, without knowing if they land inside plain text, inside an attribute value or elsewhere, is not usable in production.
*
* @see StringEscapeUtils
* @author wglass
* @since 1.5
* @deprecated impractical use
*/
public class EscapeXmlReference extends EscapeReference
{
/**
* Escape all XML entities.
*
* @param text
* @return An escaped String.
* @see StringEscapeUtils
*/
@Override
protected String escape(Object text)
{
return StringEscapeUtils.escapeXml10(text.toString());
}
/**
* @return attribute "eventhandler.escape.xml.match"
*/
@Override
protected String getMatchAttribute()
{
return "eventhandler.escape.xml.match";
}
}