Package org.apache.tomcat.util.security
Class Escape
java.lang.Object
org.apache.tomcat.util.security.Escape
Provides utility methods to escape content for different contexts. It is
critical that the escaping used is correct for the context in which the data
is to be used.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic String
htmlElementContent
(String content) Escape content for use in HTML.static String
htmlElementContext
(Object obj) Convert the object to a string viaObject.toString()
and HTML escape the resulting string for use in HTML content.static String
Escape content for use in XML.static String
Escape content for use in XML.static String
Escape content for use in XML.
-
Constructor Details
-
Escape
public Escape()
-
-
Method Details
-
htmlElementContent
Escape content for use in HTML. This escaping is suitable for the following uses:- Element content when the escaped data will be placed directly inside tags such as <p>, <td> etc.
- Attribute values when the attribute value is quoted with " or '.
- Parameters:
content
- The content to escape- Returns:
- The escaped content or
null
if the content wasnull
-
htmlElementContext
Convert the object to a string viaObject.toString()
and HTML escape the resulting string for use in HTML content.- Parameters:
obj
- The object to convert to String and then escape- Returns:
- The escaped content or
"?"
if obj isnull
-
xml
Escape content for use in XML.- Parameters:
content
- The content to escape- Returns:
- The escaped content or
null
if the content wasnull
-
xml
Escape content for use in XML.- Parameters:
ifNull
- The value to return if content isnull
content
- The content to escape- Returns:
- The escaped content or the value of
ifNull
if the content wasnull
-
xml
Escape content for use in XML.- Parameters:
ifNull
- The value to return if content isnull
escapeCRLF
- Should CR and LF also be escaped?content
- The content to escape- Returns:
- The escaped content or the value of ifNull if the content was
null
-