org.exoplatform.ecm.utils.text

Class Text

java.lang.Object

org.exoplatform.ecm.utils.text.Text

public class Text
extends Object

This Class provides some text related utilities

Constructor Summary

Constructors

Constructor and Description
Text()

Method Summary

Modifier and Type	Method and Description
static String	convertJcrChars(String name) converts all illegal JCR name characters of a string to '-'
static String	escape(String string, char escape, boolean isPath)
static String	escape(String string, char escape, boolean isPath, String extraCharacters) Does an URL encoding of the string using the escape character.
static String	escapeIllegalJcrChars(String name) Escapes all illegal JCR name characters of a string.
static String	unescapeIllegalJcrChars(String name) Unescapes previously escaped jcr chars.

Methods inherited from class java.lang.Object

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

Constructor Detail

Text

public Text()

Method Detail

escape

public static String escape(String string,
                            char escape,
                            boolean isPath)

escape

public static String escape(String string,
                            char escape,
                            boolean isPath,
                            String extraCharacters)

Does an URL encoding of the string using the escape character. The characters that don't need encoding are those defined 'unreserved' in section 2.3 of the 'URI generic syntax' RFC 2396, but without the escape character. If isPath is true, additionally the slash '/' is ignored, too.

Parameters:

string - the string to encode.

escape - the escape character.

isPath - if true, the string is treated as path

extraCharacters - the extra characters that will not be encoded.

Returns:

the escaped string

Throws:

NullPointerException - if string is null.

escapeIllegalJcrChars

public static String escapeIllegalJcrChars(String name)

Escapes all illegal JCR name characters of a string. The encoding is loosely modeled after URI encoding, but only encodes the characters it absolutely needs to in order to make the resulting string a valid JCR name. Use unescapeIllegalJcrChars(String) for decoding.
QName EBNF:
<xmp> simplename ::= onecharsimplename | twocharsimplename | threeormorecharname onecharsimplename ::= (* Any Unicode character except: '.', '/', ':', '[', ']', '*', ''', '"', '|' or any whitespace character *) twocharsimplename ::= '.' onecharsimplename | onecharsimplename '.' | onecharsimplename onecharsimplename threeormorecharname ::= nonspace string nonspace string ::= char | string char char ::= nonspace | ' ' nonspace ::= (* Any Unicode character except: '/', ':', '[', ']', '*', ''', '"', '|' or any whitespace character *) </xmp>

Parameters:

name - the name to escape

Returns:

the escaped name

unescapeIllegalJcrChars

public static String unescapeIllegalJcrChars(String name)

Unescapes previously escaped jcr chars.
Please note, that this does not exactly the same as the url related unescape(String), since it handles the encoding differently.

Parameters:

name - the name to unescape

Returns:

the unescaped name

convertJcrChars

public static String convertJcrChars(String name)

converts all illegal JCR name characters of a string to '-'

Parameters:

name - the name to escape

Returns:

the converted name