com.vladsch.flexmark.util.html

Class Escaping

java.lang.Object

com.vladsch.flexmark.util.html.Escaping

public class Escaping
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ESCAPABLE
static String	ESCAPABLE_CHARS

Constructor Summary

Constructors

Constructor and Description
Escaping()

Method Summary

Modifier and Type	Method and Description
static BasedSequence	collapseWhitespace(BasedSequence s, ReplacedTextMapper textMapper)
static String	collapseWhitespace(CharSequence s, boolean trim) Collapse regions of multiple white spaces to a single space
static BasedSequence	escapeHtml(BasedSequence s, boolean preserveEntities, ReplacedTextMapper textMapper)
static String	escapeHtml(CharSequence s, boolean preserveEntities)
static BasedSequence	normalizeEndWithEOL(BasedSequence s, ReplacedTextMapper textMapper) Normalize eol: embedded \r and \r\n are converted to \n
static String	normalizeEndWithEOL(CharSequence s) Normalize eol: embedded \r and \r\n are converted to \n
static BasedSequence	normalizeEOL(BasedSequence s, ReplacedTextMapper textMapper) Normalize eol: embedded \r and \r\n are converted to \n
static BasedSequence	normalizeEOL(BasedSequence s, ReplacedTextMapper textMapper, boolean endWithEOL) Normalize eol: embedded \r and \r\n are converted to \n
static String	normalizeEOL(CharSequence s) Normalize eol: embedded \r and \r\n are converted to \n
static String	normalizeEOL(CharSequence s, boolean endWithEOL) Normalize eol: embedded \r and \r\n are converted to \n
static String	normalizeReference(CharSequence s, boolean changeCase) Normalize the link reference id
static String	normalizeReferenceChars(CharSequence s, boolean changeCase) Get a normalized the link reference id from reference characters
static String	obfuscate(String email, boolean randomize) e-mail obfuscation from pegdown
static String	percentEncodeUrl(CharSequence s)
static BasedSequence	removeAll(BasedSequence s, CharSequence remove, ReplacedTextMapper textMapper) Replace entities and backslash escapes with literal characters.
static BasedSequence	unescape(BasedSequence s, ReplacedTextMapper textMapper) Replace entities and backslash escapes with literal characters.
static BasedSequence	unescapeHtml(BasedSequence s, ReplacedTextMapper textMapper) Replace entities and backslash escapes with literal characters.
static String	unescapeHtml(CharSequence s) Replace entities and backslash escapes with literal characters.
static String	unescapeString(CharSequence s) Replace entities and backslash escapes with literal characters.
static String	unescapeString(CharSequence s, boolean unescapeEntities) Replace entities and backslash escapes with literal characters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ESCAPABLE_CHARS

public static final String ESCAPABLE_CHARS

See Also:

Constant Field Values

ESCAPABLE

public static final String ESCAPABLE

Constructor Detail

Escaping

public Escaping()

Method Detail

escapeHtml

public static String escapeHtml(CharSequence s,
                                boolean preserveEntities)

escapeHtml

public static BasedSequence escapeHtml(BasedSequence s,
                                       boolean preserveEntities,
                                       ReplacedTextMapper textMapper)

unescapeString

public static String unescapeString(CharSequence s)

Replace entities and backslash escapes with literal characters.

Parameters:

s - string to un-escape

Returns:

un-escaped string

unescapeString

public static String unescapeString(CharSequence s,
                                    boolean unescapeEntities)

Replace entities and backslash escapes with literal characters.

Parameters:

s - string to un-escape

unescapeEntities - true if HTML entities are to be unescaped

Returns:

un-escaped string

unescape

public static BasedSequence unescape(BasedSequence s,
                                     ReplacedTextMapper textMapper)

Replace entities and backslash escapes with literal characters.

Parameters:

s - based sequence to un-escape

textMapper - replaced text mapper to update for the changed text

Returns:

un-escaped sequence

removeAll

public static BasedSequence removeAll(BasedSequence s,
                                      CharSequence remove,
                                      ReplacedTextMapper textMapper)

Replace entities and backslash escapes with literal characters.

Parameters:

s - sequence being changed

remove - string to remove

textMapper - replaced text mapper to update for the changed text

Returns:

un-escaped sequence

unescapeHtml

public static String unescapeHtml(CharSequence s)

Replace entities and backslash escapes with literal characters.

Parameters:

s - string to un-escape

Returns:

un-escaped string

unescapeHtml

public static BasedSequence unescapeHtml(BasedSequence s,
                                         ReplacedTextMapper textMapper)

Replace entities and backslash escapes with literal characters.

Parameters:

s - based sequence to un-escape

textMapper - replaced text mapper to update for the changed text

Returns:

un-escaped sequence

normalizeEndWithEOL

public static String normalizeEndWithEOL(CharSequence s)

Normalize eol: embedded \r and \r\n are converted to \n

Append EOL sequence if sequence does not already end in EOL

Parameters:

s - sequence to convert

Returns:

converted sequence

normalizeEOL

public static String normalizeEOL(CharSequence s)

Normalize eol: embedded \r and \r\n are converted to \n

Parameters:

s - sequence to convert

Returns:

converted sequence

normalizeEOL

public static String normalizeEOL(CharSequence s,
                                  boolean endWithEOL)

Normalize eol: embedded \r and \r\n are converted to \n

Parameters:

s - sequence to convert

endWithEOL - true if an EOL is to be appended to the end of the sequence if not already ending with one.

Returns:

converted sequence

normalizeEndWithEOL

public static BasedSequence normalizeEndWithEOL(BasedSequence s,
                                                ReplacedTextMapper textMapper)

Normalize eol: embedded \r and \r\n are converted to \n

Append EOL sequence if sequence does not already end in EOL

Parameters:

s - sequence to convert

textMapper - text mapper to update for the replaced text

Returns:

converted sequence

normalizeEOL

public static BasedSequence normalizeEOL(BasedSequence s,
                                         ReplacedTextMapper textMapper)

Normalize eol: embedded \r and \r\n are converted to \n

Parameters:

s - sequence to convert

textMapper - text mapper to update for the replaced text

Returns:

converted sequence

normalizeEOL

public static BasedSequence normalizeEOL(BasedSequence s,
                                         ReplacedTextMapper textMapper,
                                         boolean endWithEOL)

Normalize eol: embedded \r and \r\n are converted to \n

Append EOL sequence if sequence does not already end in EOL

Parameters:

s - sequence to convert

textMapper - text mapper to update for the replaced text

endWithEOL - whether an EOL is to be appended to the end of the sequence if it does not already end with one.

Returns:

converted sequence

percentEncodeUrl

public static String percentEncodeUrl(CharSequence s)

Parameters:

s - string to encode

Returns:

encoded string

normalizeReference

public static String normalizeReference(CharSequence s,
                                        boolean changeCase)

Normalize the link reference id

Parameters:

s - sequence containing the link reference id

changeCase - if true then reference will be converted to lowercase

Returns:

normalized link reference id

obfuscate

public static String obfuscate(String email,
                               boolean randomize)

e-mail obfuscation from pegdown

Parameters:

email - e-mail url

randomize - true to randomize, false for testing

Returns:

obfuscated e-mail url

normalizeReferenceChars

public static String normalizeReferenceChars(CharSequence s,
                                             boolean changeCase)

Get a normalized the link reference id from reference characters

Will remove leading ![ or [ and trailing ], collapse multiple whitespaces to a space and optionally convert the id to lowercase.

Parameters:

s - sequence containing the link reference id

changeCase - if true then reference will be converted to lowercase

Returns:

normalized link reference id

collapseWhitespace

public static String collapseWhitespace(CharSequence s,
                                        boolean trim)

Collapse regions of multiple white spaces to a single space

Parameters:

s - sequence to process

trim - true if the sequence should also be trimmed

Returns:

processed sequence

collapseWhitespace

public static BasedSequence collapseWhitespace(BasedSequence s,
                                               ReplacedTextMapper textMapper)