Char17 (de.mpg.mpi-inf:javatools 1.1 API)

java.lang.Object
- javatools.parsers.Char17

```
public class Char17
extends Object
```
Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
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

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<String>`	`ampersandMap` Maps HTML ampersand sequences to strings
`static IntKeyMap<String>`	`charToAmpersand` Maps a special character to a HTML ampersand sequence
`static IntKeyMap<String>`	`charToBackslash` Maps a special character to a backslash sequence
`static Char17.Legal`	`html` Any characters that can appear in HTML attributes
`static Char17.Legal`	`htmlUtf8` TRUE for HTML UTF8 characters
`static IntKeyMap<String>`	`normalizeMap` Maps characters to normalizations
`static 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()

Constructors
Constructor and Description
`Char17()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`capitalize(String s)` Capitalizes words and lowercases the rest
`static String`	`cutLast(String s)` Returns the String without the last character
`static StringBuilder`	`cutLast(StringBuilder s)` Cuts the last character
`static String`	`decode(String string)` Replaces all codes in a String by the 16 bit Unicode characters
`static String`	`decodeAmpersand(String string)` Eats an HTML ampersand code from a List of Characters
`static int`	`decodeAmpersandChar(String b)` Decodes an HTML ampersand code such as "&amp", returns -1 in case of failure
`static String`	`decodeAndNormalize(String s)` Decodes all codes in a String and normalizes all chars
`static String`	`decodeBackslash(String string)` Decodes a backslash sequence
`static String`	`decodePercentage(String string)` Decodes percentage characters of the form "%xx" in a string.
`static String`	`decodeURIPathComponent(String s)` Decodes a URI path component
`static String`	`decodeUtf8(String string)` Decodes UTF8 characters in a string.
`static String`	`encodeAmpersand(String string, Char17.Legal legal)` Encodes non-legal characters to Ampersand codes
`static String`	`encodeBackslash(CharSequence s, Char17.Legal legal)` Encodes with backslash all illegal characters
`static String`	`encodeHex(String s, Char17.Legal legal)` Replaces illegal characters in the string by hex codes (cannot be undone)
`static String`	`encodePercentage(String string, Char17.Legal legal)` Encodes a string into Percentage codes.
`static String`	`encodeURIPathComponent(String s)` Encodes a char to percentage code, if it is not a path character in the sense of URIs
`static String`	`encodeURIPathComponentXML(String string)` Encodes a char to percentage code, if it is not a path character in the sense of XMLs
`static String`	`encodeUTF8(char c)` Encodes a character to UTF8
`static String`	`encodeUTF8(String string)` Encodes a string to UTF8
`static String`	`encodeXmlAttribute(String str)` Encodes a String with reserved XML characters into a valid xml string for attributes.
`static boolean`	`endsWith(CharSequence s, 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, String s)` Tells whether a char is in a string
`static int`	`indexOf(char c, CharSequence string)` IndexOf
`static boolean`	`isAlphanumeric(char c)` Tells whether a char is alphanumeric in the sense of URIs
`static boolean`	`isEscaped(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(CharSequence s)` Returns the last character of a String or 0
`static String`	`lowCaseFirst(String s)` Lowcases the first character in a String
`static void`	`main(String[] argv)` Test routine
`static String`	`normalize(int c)` Normalizes a character to a String of characters in the range 0x20-0x7F.
`static String`	`normalize(String s)` Normalizes all chars in a String to characters 0x20-0x7F
`static void`	`test()` Tests all methods
`static boolean`	`testCase(String name, String s1, String s2)` Prints a test case
`static String`	`toHTML(String s)` Returns an HTML-String of the String
`static CharSequence`	`truncate(CharSequence s, int len)` Returns a string of the given length, fills with spaces if necessary
`static String`	`upCaseFirst(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 String UNKNOWN
```
    String returned by the default implementation of defaultNormalizer, "[?]"
  - charToAmpersand
```
public static IntKeyMap<String> charToAmpersand
```
    Maps a special character to a HTML ampersand sequence
  - charToBackslash
```
public static IntKeyMap<String> charToBackslash
```
    Maps a special character to a backslash sequence
  - ampersandMap
```
public static IntHashMap<String> ampersandMap
```
    Maps HTML ampersand sequences to strings
  - normalizeMap
```
public static IntKeyMap<String> normalizeMap
```
    Maps characters to normalizations
  - htmlUtf8
```
public static final Char17.Legal htmlUtf8
```
    TRUE for HTML UTF8 characters
  - 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 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 String decodePercentage(String string)
```
    Decodes percentage characters of the form "%xx" in a string. Also does UTF8 decoding.
  - decodeAmpersandChar
```
public static int decodeAmpersandChar(String b)
```
    Decodes an HTML ampersand code such as "&amp", returns -1 in case of failure
  - decodeAmpersand
```
public static String decodeAmpersand(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 String decodeUtf8(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 String encodeBackslash(CharSequence s,
                                     Char17.Legal legal)
```
    Encodes with backslash all illegal characters
  - decodeBackslash
```
public static String decodeBackslash(String string)
```
    Decodes a backslash sequence
  - decode
```
public static String decode(String string)
```
    Replaces all codes in a String by the 16 bit Unicode characters
  - encodeUTF8
```
public static String encodeUTF8(char c)
```
    Encodes a character to UTF8
  - encodeUTF8
```
public static String encodeUTF8(String string)
```
    Encodes a string to UTF8
  - encodeAmpersand
```
public static String encodeAmpersand(String string,
                                     Char17.Legal legal)
```
    Encodes non-legal characters to Ampersand codes
  - encodePercentage
```
public static String encodePercentage(String string,
                                      Char17.Legal legal)
```
    Encodes a string into Percentage codes. Also does UTF8 encoding.
  - encodeXmlAttribute
```
public static String encodeXmlAttribute(String str)
```
    Encodes a String with reserved XML characters into a valid xml string for attributes.
    
    Parameters:
    
    str -
    
    Returns:
  - toHTML
```
public static String toHTML(String s)
```
    Returns an HTML-String of the String
  - encodeHex
```
public static String encodeHex(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,
                         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(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 String encodeURIPathComponent(String s)
```
    Encodes a char to percentage code, if it is not a path character in the sense of URIs
  - encodeURIPathComponentXML
```
public static String encodeURIPathComponentXML(String string)
```
    Encodes a char to percentage code, if it is not a path character in the sense of XMLs
  - decodeURIPathComponent
```
public static String decodeURIPathComponent(String s)
```
    Decodes a URI path component
  - decodeAndNormalize
```
public static String decodeAndNormalize(String s)
```
    Decodes all codes in a String and normalizes all chars
  - normalize
```
public static String normalize(String s)
```
    Normalizes all chars in a String to characters 0x20-0x7F
  - last
```
public static char last(CharSequence s)
```
    Returns the last character of a String or 0
  - cutLast
```
public static String cutLast(String s)
```
    Returns the String without the last character
  - cutLast
```
public static StringBuilder cutLast(StringBuilder s)
```
    Cuts the last character
  - upCaseFirst
```
public static String upCaseFirst(String s)
```
    Upcases the first character in a String
  - lowCaseFirst
```
public static String lowCaseFirst(String s)
```
    Lowcases the first character in a String
  - truncate
```
public static CharSequence truncate(CharSequence s,
                                    int len)
```
    Returns a string of the given length, fills with spaces if necessary
  - capitalize
```
public static String capitalize(String s)
```
    Capitalizes words and lowercases the rest
  - endsWith
```
public static boolean endsWith(CharSequence s,
                               String end)
```
    TRUE if the Charsequence ends with the string
  - indexOf
```
public static int indexOf(char c,
                          CharSequence string)
```
    IndexOf
  - testCase
```
public static boolean testCase(String name,
                               String s1,
                               String s2)
```
    Prints a test case
  - test
```
public static void test()
```
    Tests all methods
  - main
```
public static void main(String[] argv)
                 throws Exception
```
    Test routine
    
    Throws:
    
    Exception

Class Char17

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNKNOWN

charToAmpersand

charToBackslash

ampersandMap

normalizeMap

htmlUtf8

uriPathComponent

alphaNumericAndSpace

html

xmlPathComponent

Constructor Detail

Char17

Method Detail

normalize

decodePercentage

decodeAmpersandChar

decodeAmpersand

Utf8Length

decodeUtf8

encodeBackslash

decodeBackslash

decode

encodeUTF8

encodeUTF8

encodeAmpersand

encodePercentage

encodeXmlAttribute

toHTML

encodeHex

in

in

isAlphanumeric

isReserved

isUnreserved

isEscaped

isSubDelim

isGenDelim

isPchar

encodeURIPathComponent

encodeURIPathComponentXML

decodeURIPathComponent

decodeAndNormalize

normalize

last

cutLast

cutLast

upCaseFirst

lowCaseFirst

truncate

capitalize

endsWith

indexOf

testCase

test

main