Package org.apache.maven.doxia.util
Class HtmlTools
java.lang.Object
org.apache.maven.doxia.util.HtmlTools
The
HtmlTools
class defines methods to HTML handling.- Since:
- 1.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final HTML.Tag[]
private static final int
private static final char
private static final char
private static final int
private static final char
private static final int
private static final char
private static final int
private static final char
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic String
Construct a valid id.static String
Encode an urlstatic String
escapeHTML
(String text) Escape special HTML characters in a String inxml
mode.static String
escapeHTML
(String text, boolean xmlMode) Escape special HTML characters in a String.static HTML.Tag
getHtmlTag
(String tagName) Returns a tag for a defined HTML tag name.private static boolean
isHighSurrogate
(char ch) static boolean
Determines if the specified text is a valid id according to the rules laid out inencodeId(String)
.private static boolean
isSupplementaryCodePoint
(int codePoint) private static boolean
isValidCodePoint
(int codePoint) static char[]
toChars
(int codePoint) Converts the given code point to an equivalent character array.private static int
toCodePoint
(char high, char low) static String
unescapeHTML
(String text) Unescapes HTML entities in a string in non xml mode.static String
unescapeHTML
(String text, boolean xmlMode) Unescapes HTML entities in a string.
-
Field Details
-
ALL_TAGS
-
TAG_MAP
-
ASCII
private static final int ASCII- See Also:
-
LUNATE_SIGMA
private static final char LUNATE_SIGMA- See Also:
-
NON_PRIVATE_USE_HIGH_SURROGATE
private static final char NON_PRIVATE_USE_HIGH_SURROGATE- See Also:
-
LOW_SURROGATE
private static final char LOW_SURROGATE- See Also:
-
MIN_HIGH_SURROGATE
private static final char MIN_HIGH_SURROGATE- See Also:
-
MAX_HIGH_SURROGATE
private static final char MAX_HIGH_SURROGATE- See Also:
-
MIN_CODE_POINT
private static final int MIN_CODE_POINT- See Also:
-
MAX_CODE_POINT
private static final int MAX_CODE_POINT- See Also:
-
MIN_SUPPLEMENTARY_CODE_POINT
private static final int MIN_SUPPLEMENTARY_CODE_POINT- See Also:
-
-
Constructor Details
-
HtmlTools
private HtmlTools()
-
-
Method Details
-
getHtmlTag
Returns a tag for a defined HTML tag name. This is one of the tags defined inHtmlMarkup
. If the given name does not represent one of the defined tags, thennull
will be returned.- Parameters:
tagName
- theString
name requested.- Returns:
- a tag constant corresponding to the
tagName
, ornull
if not found. - Since:
- 1.1
- See Also:
-
escapeHTML
Escape special HTML characters in a String inxml
mode. Note: this method doesn't escape non-ascii characters by numeric characters references.- Parameters:
text
- the String to escape, may be null.- Returns:
- The escaped text or the empty string if text == null.
- See Also:
-
escapeHTML
Escape special HTML characters in a String.< becomes
If<
> becomes>
& becomes&
" becomes"
' becomes'
if xmlMode = truexmlMode
is true, every other character than the above remains unchanged, ifxmlMode
is false, non-ascii characters get replaced by their hex code. Note: all characters are encoded, i.e.:ř = ř 𝟭 = 𝟭
- Parameters:
text
- The String to escape, may be null.xmlMode
-true
to replace also ' to &apos,false
to replace non-ascii characters by numeric characters references.- Returns:
- The escaped text or the empty string if text == null.
- Since:
- 1.1
- See Also:
-
unescapeHTML
Unescapes HTML entities in a string in non xml mode.- Parameters:
text
- theString
to unescape, may be null.- Returns:
- a new unescaped
String
,null
if null string input. - Since:
- 1.1.1.
- See Also:
-
unescapeHTML
Unescapes HTML entities in a string.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 "<Français>" will become "<Français>".
Note: all unicode entities are decoded, i.e.:ř = ř 𝟭 = 𝟭
- Parameters:
text
- theString
to unescape, may be null.xmlMode
- set totrue
to replace &apos by '.- Returns:
- a new unescaped
String
,null
if null string input. - Since:
- 1.1.1.
-
encodeURL
Encode an url- Parameters:
url
- the String to encode, may be null- Returns:
- the text encoded, null if null String input
-
encodeId
Construct a valid id.Note: this method is identical to
DoxiaUtils.encodeId( id, false )
, the rules to encode an id are laid out there.- Parameters:
id
- The id to be encoded.- Returns:
- The trimmed and encoded id, or null if id is null.
- See Also:
-
isId
Determines if the specified text is a valid id according to the rules laid out inencodeId(String)
.- Parameters:
text
- The text to be tested.- Returns:
true
if the text is a valid id, otherwisefalse
.- See Also:
-
toCodePoint
private static int toCodePoint(char high, char low) -
isHighSurrogate
private static boolean isHighSurrogate(char ch) -
isValidCodePoint
private static boolean isValidCodePoint(int codePoint) -
isSupplementaryCodePoint
private static boolean isSupplementaryCodePoint(int codePoint) -
toChars
public static char[] toChars(int codePoint) Converts the given code point to an equivalent character array.- Parameters:
codePoint
- the code point to convert.- Returns:
- If codePoint is a supplementary code point, returns a character array of length 2, otherwise a character array of length 1 containing only the original int as a char.
-