/* * 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. */ package org.apache.commons.lang3; import org.apache.commons.lang3.text.translate.AggregateTranslator; import org.apache.commons.lang3.text.translate.CharSequenceTranslator; import org.apache.commons.lang3.text.translate.EntityArrays; import org.apache.commons.lang3.text.translate.LookupTranslator; import org.apache.commons.lang3.text.translate.NumericEntityUnescaper; /** *

* Escapes and unescapes {@code String}s for Java, Java Script, HTML and XML. *

*

* #ThreadSafe# *

* * @since 2.0 * @version $Id: StringEscapeUtils.java 1148520 2011-07-19 20:53:23Z ggregory $ */ public class StringEscapeUtils { /* ESCAPE TRANSLATORS */ /** * Translator object for escaping HTML version 3.0. While * {@link #escapeHtml3(String)} is the expected method of use, this object * allows the HTML escaping functionality to be used as the foundation for a * custom translator. * * @since 3.0 */ public static final CharSequenceTranslator ESCAPE_HTML3 = new AggregateTranslator(new LookupTranslator( EntityArrays.BASIC_ESCAPE()), new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE())); /** * Translator object for escaping HTML version 4.0. While * {@link #escapeHtml4(String)} is the expected method of use, this object * allows the HTML escaping functionality to be used as the foundation for a * custom translator. * * @since 3.0 */ public static final CharSequenceTranslator ESCAPE_HTML4 = new AggregateTranslator(new LookupTranslator( EntityArrays.BASIC_ESCAPE()), new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE()), new LookupTranslator( EntityArrays.HTML40_EXTENDED_ESCAPE())); /* UNESCAPE TRANSLATORS */ /** * Translator object for unescaping escaped HTML 3.0. While * {@link #unescapeHtml3(String)} is the expected method of use, this object * allows the HTML unescaping functionality to be used as the foundation for * a custom translator. * * @since 3.0 */ public static final CharSequenceTranslator UNESCAPE_HTML3 = new AggregateTranslator(new LookupTranslator( EntityArrays.BASIC_UNESCAPE()), new LookupTranslator(EntityArrays.ISO8859_1_UNESCAPE()), new NumericEntityUnescaper()); /** * Translator object for unescaping escaped HTML 4.0. While * {@link #unescapeHtml4(String)} is the expected method of use, this object * allows the HTML unescaping functionality to be used as the foundation for * a custom translator. * * @since 3.0 */ public static final CharSequenceTranslator UNESCAPE_HTML4 = new AggregateTranslator(new LookupTranslator( EntityArrays.BASIC_UNESCAPE()), new LookupTranslator(EntityArrays.ISO8859_1_UNESCAPE()), new LookupTranslator(EntityArrays.HTML40_EXTENDED_UNESCAPE()), new NumericEntityUnescaper()); /* Helper functions */ /** *

* {@code StringEscapeUtils} instances should NOT be constructed in standard * programming. *

*

* Instead, the class should be used as: * * 

	 * StringEscapeUtils.escapeJava("foo");
	 *
* *

*

* This constructor is public to permit tools that require a JavaBean * instance to operate. *

*/ public StringEscapeUtils() { super(); } /** *

* Escapes the characters in a {@code String} using HTML entities. *

*

* Supports only the HTML 3.0 entities. *

* * @param input the {@code String} to escape, may be null * @return a new escaped {@code String}, {@code null} if null string input * @since 3.0 */ public static final String escapeHtml3(final String input) { return ESCAPE_HTML3.translate(input); } // HTML and XML // -------------------------------------------------------------------------- /** *

* Escapes the characters in a {@code String} using HTML entities. *

*

* For example: *

*

* "bread" & "butter" *

* becomes: *

* "bread" & "butter" * . *

*

* Supports all known HTML 4.0 entities, including funky accents. Note that * the commonly used apostrophe escape character (') is not a legal * entity and so is not supported). *

* * @param input the {@code String} to escape, may be null * @return a new escaped {@code String}, {@code null} if null string input * @see ISO * Entities * @see HTML 3.2 Character * Entities for ISO Latin-1 * @see HTML * 4.0 Character entity references * @see HTML 4.01 * Character References * @see HTML * 4.01 Code positions * @since 3.0 */ public static final String escapeHtml4(final String input) { return ESCAPE_HTML4.translate(input); } /** *

* Unescapes a string containing entity escapes to a string containing the * actual Unicode characters corresponding to the escapes. Supports only * HTML 3.0 entities. *

* * @param input the {@code String} to unescape, may be null * @return a new unescaped {@code String}, {@code null} if null string input * @since 3.0 */ public static final String unescapeHtml3(final String input) { return UNESCAPE_HTML3.translate(input); } // ----------------------------------------------------------------------- /** *

* Unescapes a string containing entity escapes to a string containing the * actual Unicode characters corresponding to the escapes. Supports HTML 4.0 * entities. *

*

* For example, the string "&lt;Fran&ccedil;ais&gt;" will become * "<Français>" *

*

* If an entity is unrecognized, it is left alone, and inserted verbatim * into the result string. e.g. "&gt;&zzzz;x" will become * ">&zzzz;x". *

* * @param input the {@code String} to unescape, may be null * @return a new unescaped {@code String}, {@code null} if null string input * @since 3.0 */ public static final String unescapeHtml4(final String input) { return UNESCAPE_HTML4.translate(input); } }