cz.ues.platform.commons.uri

Class UESURIStringEscaper

java.lang.Object

cz.ues.platform.commons.uri.UESURIStringEscaper

public class UESURIStringEscaper
extends java.lang.Object

UESURIStringEscaper takes care of escaping UES URI strings.

This class is NOT part of public URI API! It is intended only for internal usage within URI module.

Since:

UES7-06

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CONTROL_CHARACTERS String which contains all characters which belongs to "control" character category.
static java.lang.String	ESCAPE_CHARS The following characters must be escaped in UESURI.
static java.lang.String	EXPR_IMMEDIATE_BEGIN This is the character sequence which starts the immediate expression.
private static int	MAX_NONESCAPED_CHAR_VALUE Characters with a numerical value greater than this will be escaped.
protected static java.lang.String	SPACE_CHARACTERS String which contains all characters which belongs to "space" character category.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UESURIStringEscaper() Protected constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	escape(java.lang.String value) This function replaces reserved characters and the more weird unicode character with their escaped representation.
static java.lang.String	escape(java.lang.String value, boolean escapeDiacritics) This function replaces reserved characters and the more weird characters with their escaped representation.
private static void	escapeUnicodeChar(java.lang.StringBuffer sb, char ch) Replaces a unicode character with its escaped representation ("") and appends the result to a StringBuffer.
private static java.lang.String	getControlCharacters() Returns string which contains control characters (see BNF in	private static java.lang.String	getSpaceCharacters() Returns string which contains all characters which belongs to "space" category (see BNF in	private static java.lang.StringBuilder	getStringWithCharacters(int begin, int end) Returns a string which contains all characters within specified range.

Methods inherited from class java.lang.Object

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

Field Detail

SPACE_CHARACTERS

protected static final SPACE_CHARACTERS

String which contains all characters which belongs to "space" character category.

CONTROL_CHARACTERS

protected static final CONTROL_CHARACTERS

String which contains all characters which belongs to "control" character category.

ESCAPE_CHARS

public static final ESCAPE_CHARS

The following characters must be escaped in UESURI.

EXPR_IMMEDIATE_BEGIN

public static final EXPR_IMMEDIATE_BEGIN

This is the character sequence which starts the immediate expression. We treat it as one character.

See Also:

Constant Field Values

MAX_NONESCAPED_CHAR_VALUE

private static final MAX_NONESCAPED_CHAR_VALUE

Characters with a numerical value greater than this will be escaped.

See Also:

Constant Field Values

Constructor Detail

UESURIStringEscaper

protected UESURIStringEscaper()

Protected constructor.

Method Detail

getSpaceCharacters

private static java.lang.String getSpaceCharacters()

Returns string which contains all characters which belongs to "space" category (see BNF in UESURI HLC).

Returns:

string which contains all characters which belongs to "space" category.

Since:

UES7-06

getControlCharacters

private static java.lang.String getControlCharacters()

Returns string which contains control characters (see BNF in UESURI HLC).

Unicode code of control characters are: ("" ... "") | ("" ... "Ÿ")

Returns:

String which contains control characters.

Since:

UES7-06

getStringWithCharacters

private static java.lang.StringBuilder getStringWithCharacters(int begin,
int end)

Returns a string which contains all characters within specified range.

Parameters:

begin - The lowest index of character (inclusive).

end - The highest index of character (inclusive).

Returns:

A string which contains all characters within specified range.

Since:

UES7-06

escape

public static java.lang.String escape(java.lang.String value)

This function replaces reserved characters and the more weird unicode character with their escaped representation.

Parameters:

value - the input string

Returns:

string with escaped characters

Since:

UES6-00

escape

public static java.lang.String escape(java.lang.String value,
boolean escapeDiacritics)

This function replaces reserved characters and the more weird characters with their escaped representation.

Parameters:

value - A string to escape.

escapeDiacritics - If this parameter has the true value, diacritics characters are escaped using Unicode escaping style.

Returns:

String which contains escaped non-regular characters.

Since:

UES6-00

escapeUnicodeChar

private static void escapeUnicodeChar(java.lang.StringBuffer sb,
char ch)

Replaces a unicode character with its escaped representation ("") and appends the result to a StringBuffer.

Parameters:

sb - the stringbuffer to append the result to

ch - the unicode character to escape

Since:

UES6-00