info.bliki.wiki.filter

Class Encoder

java.lang.Object

info.bliki.wiki.filter.Encoder

public class Encoder
extends Object

Some helper methods for encoding strings to HTML, URL or local files system names

Constructor Summary

Constructors

Constructor and Description
Encoder()

Method Summary

Modifier and Type	Method and Description
static String	encodeDotUrl(String s) Encode a string to the "x-www-form-urlencoded" form, enhanced with the UTF-8-in-URL proposal.
static String	encodeHtml(String text)
static void	encodeHtml(String text, StringBuilder buffer) copy the text in the resulting buffer and escape special html characters (< > " ( " ) & ')
static String	encodeTitleDotUrl(String wikiTitle, boolean firstCharacterAsUpperCase)
static String	encodeTitleLocalUrl(String title) Encode name for local file system
static String	encodeTitleToUrl(String wikiTitle, boolean firstCharacterAsUpperCase) Encode the wiki links title into a URL for HTML hyperlinks (i.e.
static String	encodeUrl(String s) Encode a string to the "x-www-form-urlencoded" form, enhanced with the UTF-8-in-URL proposal.
static boolean	isUrlIdentifierPart(char ch) Determines if the specified character may be part of a url
static String	normaliseTitle(String value, boolean underScoreIsWhitespace, char whiteSpaceChar, boolean firstCharacterAsUpperCase) Normalises the given title, i.e.
static String	normaliseTitle(String value, boolean underScoreIsWhitespace, char whiteSpaceChar, boolean firstCharacterAsUpperCase, boolean encodeUrl) Normalises the given title, i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

Encoder

public Encoder()

Method Detail

encodeUrl

public static String encodeUrl(String s)

Encode a string to the "x-www-form-urlencoded" form, enhanced with the UTF-8-in-URL proposal. This is what happens: See https://www.w3.org/International/URLUTF8Encoder.java ) Exception: a ' ' (space) will be replaced by a '_' (underscore) not '+' (plus); a '#' remain the same.

• The ASCII characters 'a' through 'z', 'A' through 'Z', and '0' through '9' remain the same.

• The unreserved characters - _ . ! ~ * ' ( ) / remain the same.

• The '#' character remains the same.

• The space character ' ' is converted into a underscore sign '_' (not a plus sign '+'!).

• All other ASCII characters are converted into the 3-character string "%xy", where xy is the two-digit hexadecimal representation of the character code

• All non-ASCII characters are encoded in two steps: first to a sequence of 2 or 3 bytes, using the UTF-8 algorithm; secondly each of these bytes is encoded as ".xx".

Parameters:

s - The string to be encoded

Returns:

The encoded string

encodeDotUrl

public static String encodeDotUrl(String s)

Encode a string to the "x-www-form-urlencoded" form, enhanced with the UTF-8-in-URL proposal. This is what happens: 8see https://www.w3.org/International/URLUTF8Encoder.java ) Exception: a ' ' (space) will be replaced by a '_' (underscore) not '+' (plus)

• The ASCII characters 'a' through 'z', 'A' through 'Z', and '0' through '9' remain the same.

• The unreserved characters - _ . ! ~ * ' ( ) / remain the same.

• The space character ' ' is converted into a underscore sign '_' (not a plus sign '+').

• All other ASCII characters are converted into the 3-character string "%xy", where xy is the two-digit hexadecimal representation of the character code

• All non-ASCII characters are encoded in two steps: first to a sequence of 2 or 3 bytes, using the UTF-8 algorithm; secondly each of these bytes is encoded as ".xx".

Parameters:

s - The string to be encoded

Returns:

The encoded string

encodeTitleToUrl

public static String encodeTitleToUrl(String wikiTitle,
                                      boolean firstCharacterAsUpperCase)

Encode the wiki links title into a URL for HTML hyperlinks (i.e. create the href attribute representation for the a tag). To get the behavior of the MediaWiki software, which is configured to convert the first letter to upper case, the firstCharacterAsUpperCase parameters must be set to true.

Parameters:

wikiTitle - the raw wiki title

firstCharacterAsUpperCase - if true convert the first of the title to upper case

Returns:

the encoded wiki title

encodeTitleDotUrl

public static String encodeTitleDotUrl(String wikiTitle,
                                       boolean firstCharacterAsUpperCase)

encodeTitleLocalUrl

public static String encodeTitleLocalUrl(String title)

Encode name for local file system

normaliseTitle

public static String normaliseTitle(String value,
                                    boolean underScoreIsWhitespace,
                                    char whiteSpaceChar,
                                    boolean firstCharacterAsUpperCase)

Normalises the given title, i.e. capitalises the first letter and replaces whitespace with whitespaceChar, also multiple consecutive whitespace characters will be replaced by one whitespaceChar.

Parameters:

value - the string

underScoreIsWhitespace - whether '_' should be seen as whitespace or not

whiteSpaceChar - the character to replace whitespace with

firstCharacterAsUpperCase - if true convert the first of the title to upper case

Returns:

a normalised title

normaliseTitle

public static String normaliseTitle(String value,
                                    boolean underScoreIsWhitespace,
                                    char whiteSpaceChar,
                                    boolean firstCharacterAsUpperCase,
                                    boolean encodeUrl)

Normalises the given title, i.e. capitalises the first letter and replaces whitespace with whitespaceChar, also multiple consecutive whitespace characters will be replaced by one whitespaceChar. If encodeUrl is set, each character will be mangled through encodeUrl(StringBuilder, int) after all the previous replacements!

Parameters:

value - the string

underScoreIsWhitespace - whether '_' should be seen as whitespace or not

whiteSpaceChar - the character to replace whitespace with

firstCharacterAsUpperCase - if true convert the first of the title to upper case

encodeUrl - finally mangles each character through encodeUrl(StringBuilder, int)

Returns:

a normalised title

encodeHtml

public static void encodeHtml(String text,
                              StringBuilder buffer)

copy the text in the resulting buffer and escape special html characters (< > " ( " ) & ')

Parameters:

buffer - add converted text into the resulting buffer

encodeHtml

public static String encodeHtml(String text)

isUrlIdentifierPart

public static boolean isUrlIdentifierPart(char ch)

Determines if the specified character may be part of a url