javatools.parsers

Class Char17

java.lang.Object

javatools.parsers.Char17

public class Char17
extends java.lang.Object

This class is part of the Java Tools (see http://mpii.de/yago-naga/javatools). It is licensed under the Creative Commons Attribution License (see http://creativecommons.org/licenses/by/3.0) by the YAGO-NAGA team (see http://mpii.de/yago-naga).

This class is the improved version of the original Char class, which takes into account that Java 1.7 performs a copy for substring()

This class provides static methods to decode, encode and normalize Strings.
Decoding converts the following codes to Java 16-bit characters ( char):

• all HTML ampersand codes (like  ) as specified by the W3C
• all backslash codes (like \ b) as specified by the Java language specification
• all percentage codes (like %2C) as used in URLs and E-Mails
• all UTF-8 codes (like ī) as specified in Wikipedia

Encoding is the inverse operation. It takes a Java 16-bit character ( char) and outputs its encoding in HTML, as a backslash code, as a percentage code or in UTF8.

Normalization converts the following Unicode characters (Java 16-bit chars) to ASCII-characters in the range 0x20-0x7F:

• all ASCII control characters (0x00-0x1F)
• all Latin-1 characters (0x80-0xFF) to the closest transliteration
• all Latin Extended-A characters (0x100-0x17F) to the closest transliteration
• all Greek characters (0x374-0x3D6) to the closest transliteration as specified in Wikipedia
• all General-Punctuation characters (0x2016-0x2055) to the closest ASCII punctuation
• most mathematical symbols (in the range of 0x2000) to the common program code identifier or text
• all ligatures (0xFB00-0xFB06, the nasty things you get when you copy/paste from PDFs) to the separate characters

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Char17.Legal Used for encoding selected characters

Field Summary

Fields

Modifier and Type	Field and Description
static Char17.Legal	alphaNumericAndSpace True for ASCII alphanumeric and space
static IntHashMap<java.lang.String>	ampersandMap Maps HTML ampersand sequences to strings
static IntKeyMap<java.lang.String>	charToAmpersand Maps a special character to a HTML ampersand sequence
static IntKeyMap<java.lang.String>	charToBackslash Maps a special character to a backslash sequence
static Char17.Legal	html Any characters that can appear in HTML attributes
static IntKeyMap<java.lang.String>	normalizeMap Maps characters to normalizations
static java.lang.String	UNKNOWN String returned by the default implementation of defaultNormalizer, "[?]"
static Char17.Legal	uriPathComponent Legal path components in the sense of URIs
static Char17.Legal	xmlPathComponent TRUE for XML path components

Constructor Summary

Constructors

Constructor and Description
Char17()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	capitalize(java.lang.String s) Capitalizes words and lowercases the rest
static java.lang.String	cutLast(java.lang.String s) Returns the String without the last character
static java.lang.StringBuilder	cutLast(java.lang.StringBuilder s) Cuts the last character
static java.lang.String	decode(java.lang.String string) Replaces all codes in a String by the 16 bit Unicode characters
static java.lang.String	decodeAmpersand(java.lang.String string) Eats an HTML ampersand code from a List of Characters
static int	decodeAmpersandChar(java.lang.String b) Decodes an HTML ampersand code such as "& amp", returns -1 in case of failure
static java.lang.String	decodeAndNormalize(java.lang.String s) Decodes all codes in a String and normalizes all chars
static java.lang.String	decodeBackslash(java.lang.String string) Decodes a backslash sequence
static java.lang.String	decodePercentage(java.lang.String string) Decodes percentage characters of the form "%xx" in a string.
static java.lang.String	decodeURIPathComponent(java.lang.String s) Decodes a URI path component
static java.lang.String	decodeUtf8(java.lang.String string) Decodes UTF8 characters in a string.
static java.lang.String	encodeAmpersand(java.lang.String string, Char17.Legal legal) Encodes non-legal characters to Ampersand codes
static java.lang.String	encodeBackslash(java.lang.CharSequence s, Char17.Legal legal) Encodes with backslash all illegal characters
static java.lang.String	encodeHex(java.lang.String s, Char17.Legal legal) Replaces illegal characters in the string by hex codes (cannot be undone)
static java.lang.String	encodePercentage(java.lang.String string, Char17.Legal legal) Encodes a string into Percentage codes.
static java.lang.String	encodeURIPathComponent(java.lang.String s) Encodes a char to percentage code, if it is not a path character in the sense of URIs
static java.lang.String	encodeURIPathComponentXML(java.lang.String string) Encodes a char to percentage code, if it is not a path character in the sense of XMLs
static java.lang.String	encodeUTF8(char c) Encodes a character to UTF8
static java.lang.String	encodeUTF8(java.lang.String string) Encodes a string to UTF8
static java.lang.String	encodeXmlAttribute(java.lang.String str) Encodes a String with reserved XML characters into a valid xml string for attributes.
static boolean	endsWith(java.lang.CharSequence s, java.lang.String end) TRUE if the Charsequence ends with the string
static boolean	in(char c, char a, char b) Tells whether a char is in a range
static boolean	in(char c, java.lang.String s) Tells whether a char is in a string
static int	indexOf(char c, java.lang.CharSequence string) IndexOf
static boolean	isAlphanumeric(char c) Tells whether a char is alphanumeric in the sense of URIs
static boolean	isEscaped(java.lang.String s) Tells whether a string is escaped in the sense of URIs
static boolean	isGenDelim(char c) Tells whether a char is a general delimiter in the sense of URIs
static boolean	isPchar(char c) Tells whether a char is a valid path component in the sense of URIs
static boolean	isReserved(char c) Tells whether a char is reserved in the sense of URIs
static boolean	isSubDelim(char c) Tells whether a char is a sub-delimiter in the sense of URIs
static boolean	isUnreserved(char c) Tells whether a char is unreserved in the sense of URIs (not the same as !reserved)
static char	last(java.lang.CharSequence s) Returns the last character of a String or 0
static java.lang.String	lowCaseFirst(java.lang.String s) Lowcases the first character in a String
static void	main(java.lang.String[] argv) Test routine
static java.lang.String	normalize(int c) Normalizes a character to a String of characters in the range 0x20-0x7F.
static java.lang.String	normalize(java.lang.String s) Normalizes all chars in a String to characters 0x20-0x7F
static void	test() Tests all methods
static boolean	testCase(java.lang.String name, java.lang.String s1, java.lang.String s2) Prints a test case
static java.lang.String	toHTML(java.lang.String s) Returns an HTML-String of the String
static java.lang.CharSequence	truncate(java.lang.CharSequence s, int len) Returns a string of the given length, fills with spaces if necessary
static java.lang.String	upCaseFirst(java.lang.String s) Upcases the first character in a String
static int	Utf8Length(char c) Tells from the first UTF-8 code character how long the code is.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static java.lang.String UNKNOWN

String returned by the default implementation of defaultNormalizer, "[?]"

charToAmpersand

public static IntKeyMap<java.lang.String> charToAmpersand

Maps a special character to a HTML ampersand sequence

charToBackslash

public static IntKeyMap<java.lang.String> charToBackslash

Maps a special character to a backslash sequence

ampersandMap

public static IntHashMap<java.lang.String> ampersandMap

Maps HTML ampersand sequences to strings

normalizeMap

public static IntKeyMap<java.lang.String> normalizeMap

Maps characters to normalizations

uriPathComponent

public static final Char17.Legal uriPathComponent

Legal path components in the sense of URIs

alphaNumericAndSpace

public static final Char17.Legal alphaNumericAndSpace

True for ASCII alphanumeric and space

html

public static final Char17.Legal html

Any characters that can appear in HTML attributes

xmlPathComponent

public static final Char17.Legal xmlPathComponent

TRUE for XML path components

Constructor Detail

Char17

public Char17()

Method Detail

normalize

public static java.lang.String normalize(int c)

Normalizes a character to a String of characters in the range 0x20-0x7F. Returns a String, because some characters are normalized to multiple characters (e.g. umlauts) and some characters are normalized to zero characters (e.g. special Unicode space chars). Returns null for the EndOfFile character -1

decodePercentage

public static java.lang.String decodePercentage(java.lang.String string)

Decodes percentage characters of the form "%xx" in a string. Also does UTF8 decoding.

decodeAmpersandChar

public static int decodeAmpersandChar(java.lang.String b)

Decodes an HTML ampersand code such as "& amp", returns -1 in case of failure

decodeAmpersand

public static java.lang.String decodeAmpersand(java.lang.String string)

Eats an HTML ampersand code from a List of Characters

Utf8Length

public static int Utf8Length(char c)

Tells from the first UTF-8 code character how long the code is. Returns -1 if the character is not an UTF-8 code start. Returns 1 if the character is ASCII<128

decodeUtf8

public static java.lang.String decodeUtf8(java.lang.String string)

Decodes UTF8 characters in a string. There is also a built-in way in Java that converts UTF8 to characters and back, but it does not work with all characters.

encodeBackslash

public static java.lang.String encodeBackslash(java.lang.CharSequence s,
                                               Char17.Legal legal)

Encodes with backslash all illegal characters

decodeBackslash

public static java.lang.String decodeBackslash(java.lang.String string)

Decodes a backslash sequence

decode

public static java.lang.String decode(java.lang.String string)

Replaces all codes in a String by the 16 bit Unicode characters

encodeUTF8

public static java.lang.String encodeUTF8(char c)

Encodes a character to UTF8

encodeUTF8

public static java.lang.String encodeUTF8(java.lang.String string)

Encodes a string to UTF8

encodeAmpersand

public static java.lang.String encodeAmpersand(java.lang.String string,
                                               Char17.Legal legal)

Encodes non-legal characters to Ampersand codes

encodePercentage

public static java.lang.String encodePercentage(java.lang.String string,
                                                Char17.Legal legal)

Encodes a string into Percentage codes. Also does UTF8 encoding.

encodeXmlAttribute

public static java.lang.String encodeXmlAttribute(java.lang.String str)

Encodes a String with reserved XML characters into a valid xml string for attributes.

Parameters:

str -

Returns:

toHTML

public static java.lang.String toHTML(java.lang.String s)

Returns an HTML-String of the String

encodeHex

public static java.lang.String encodeHex(java.lang.String s,
                                         Char17.Legal legal)

Replaces illegal characters in the string by hex codes (cannot be undone)

in

public static boolean in(char c,
                         char a,
                         char b)

Tells whether a char is in a range

in

public static boolean in(char c,
                         java.lang.String s)

Tells whether a char is in a string

isAlphanumeric

public static boolean isAlphanumeric(char c)

Tells whether a char is alphanumeric in the sense of URIs

isReserved

public static boolean isReserved(char c)

Tells whether a char is reserved in the sense of URIs

isUnreserved

public static boolean isUnreserved(char c)

Tells whether a char is unreserved in the sense of URIs (not the same as !reserved)

isEscaped

public static boolean isEscaped(java.lang.String s)

Tells whether a string is escaped in the sense of URIs

isSubDelim

public static boolean isSubDelim(char c)

Tells whether a char is a sub-delimiter in the sense of URIs

isGenDelim

public static boolean isGenDelim(char c)

Tells whether a char is a general delimiter in the sense of URIs

isPchar

public static boolean isPchar(char c)

Tells whether a char is a valid path component in the sense of URIs

encodeURIPathComponent

public static java.lang.String encodeURIPathComponent(java.lang.String s)

Encodes a char to percentage code, if it is not a path character in the sense of URIs

encodeURIPathComponentXML

public static java.lang.String encodeURIPathComponentXML(java.lang.String string)

Encodes a char to percentage code, if it is not a path character in the sense of XMLs

decodeURIPathComponent

public static java.lang.String decodeURIPathComponent(java.lang.String s)

Decodes a URI path component

decodeAndNormalize

public static java.lang.String decodeAndNormalize(java.lang.String s)

Decodes all codes in a String and normalizes all chars

normalize

public static java.lang.String normalize(java.lang.String s)

Normalizes all chars in a String to characters 0x20-0x7F

last

public static char last(java.lang.CharSequence s)

Returns the last character of a String or 0

cutLast

public static java.lang.String cutLast(java.lang.String s)

Returns the String without the last character

cutLast

public static java.lang.StringBuilder cutLast(java.lang.StringBuilder s)

Cuts the last character

upCaseFirst

public static java.lang.String upCaseFirst(java.lang.String s)

Upcases the first character in a String

lowCaseFirst

public static java.lang.String lowCaseFirst(java.lang.String s)

Lowcases the first character in a String

truncate

public static java.lang.CharSequence truncate(java.lang.CharSequence s,
                                              int len)

Returns a string of the given length, fills with spaces if necessary

capitalize

public static java.lang.String capitalize(java.lang.String s)

Capitalizes words and lowercases the rest

endsWith

public static boolean endsWith(java.lang.CharSequence s,
                               java.lang.String end)

TRUE if the Charsequence ends with the string

indexOf

public static int indexOf(char c,
                          java.lang.CharSequence string)

IndexOf

testCase

public static boolean testCase(java.lang.String name,
                               java.lang.String s1,
                               java.lang.String s2)

Prints a test case

test

public static void test()

Tests all methods

main

public static void main(java.lang.String[] argv)
                 throws java.lang.Exception

Test routine

Throws:

java.lang.Exception