InternetCharacterConversion (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- se.entra.phantom.server.http.InternetCharacterConversion

```
public class InternetCharacterConversion
extends Object
```
This class handles character conversion for the Internet-related services such as reading HTTP PORT responses and sending data through HTML pages.

Field Summary
Fields
Modifier and Type Field and Description
static String hexes
Hex characters.

Fields
Modifier and Type	Field and Description
`static String`	`hexes` Hex characters.

Constructor Summary
Constructors
Constructor and Description
InternetCharacterConversion()

Constructors
Constructor and Description
`InternetCharacterConversion()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`convertByteToString(byte[] bytes)` Converts a byte array from a socket stream into Unicode.
`static String`	`convertByteToString(byte[] bytes, int pos, int length)` Converts a byte array from a socket stream into Unicode.
`static byte[]`	`convertStringToByte(String string)` Converts a string to a byte array for a socket stream.
`static byte[]`	`convertToHTMLString(byte[] bytes)` Converts a byte array to a HTML string with "&symbol;".
`static byte[]`	`convertToHTMLString(String s)` Converts a string to a HTML string with "&symbol;".
`static byte[]`	`convertToXMLString(byte[] bytes)` Converts a byte array to an XML string.
`static byte[]`	`convertToXMLString(String s)` Converts a String to an XML string as a byte array.
`static String`	`getCodepageString()` Gets the name of the codepage, e.g.
`static boolean`	`setCodepage(String cp)` Sets the new codepage conversion codepage.
`static String`	`stringConvertToHTMLString(String s)` Converts a string to a HTML string with "&symbol;".
`static String`	`stringConvertToXMLString(String s)` Converts a String to an XML string.
`static Hashtable<String,String>`	`urlDecode(byte[] data)` A HTML form MIME type reply.
`static String`	`urlDecode(String urlString)` A HTML form MIME type string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - hexes
```
public static final String hexes
```
    Hex characters.
    See Also:
    Constant Field Values
- Constructor Detail
  - InternetCharacterConversion
```
public InternetCharacterConversion()
```
- Method Detail
  - setCodepage
```
public static boolean setCodepage(String cp)
```
    Sets the new codepage conversion codepage. It should be 8859_1 to 8859_9.
    Returns:
    true for success, false for failure.
  - getCodepageString
```
public static String getCodepageString()
```
    Gets the name of the codepage, e.g. "iso-8859-1".
  - convertByteToString
```
public static String convertByteToString(byte[] bytes)
```
    Converts a byte array from a socket stream into Unicode.
  - convertByteToString
```
public static String convertByteToString(byte[] bytes,
                                         int pos,
                                         int length)
```
    Converts a byte array from a socket stream into Unicode.
  - convertStringToByte
```
public static byte[] convertStringToByte(String string)
```
    Converts a string to a byte array for a socket stream.
  - convertToHTMLString
```
public static byte[] convertToHTMLString(byte[] bytes)
```
    Converts a byte array to a HTML string with "&symbol;".
  - convertToHTMLString
```
public static byte[] convertToHTMLString(String s)
```
    Converts a string to a HTML string with "&symbol;".
  - stringConvertToHTMLString
```
public static String stringConvertToHTMLString(String s)
```
    Converts a string to a HTML string with "&symbol;".
  - convertToXMLString
```
public static byte[] convertToXMLString(byte[] bytes)
```
    Converts a byte array to an XML string.
  - stringConvertToXMLString
```
public static String stringConvertToXMLString(String s)
```
    Converts a String to an XML string. The ampersand character (&) and the left and right angle bracket (< and >) may appear in their literal form only when used as markup delimiters, or within comments, processing instructions, or marked sections. If they are needed in the text, they must be represented using the strings "&", "<", and ">". Parsed character data is thus any string of characters which does not contain the start-delimiter of any markup. Character data is any string of characters not including the marked-section-close delimiter, "]]>". For convenience, the single-quote character (') may be represented as "&sq;", and the double-quote character (") as "&dq;".
  - convertToXMLString
```
public static byte[] convertToXMLString(String s)
```
    Converts a String to an XML string as a byte array. The ampersand character (&) and the left and right angle bracket (< and >) may appear in their literal form only when used as markup delimiters, or within comments, processing instructions, or marked sections. If they are needed in the text, they must be represented using the strings "&", "<", and ">". Parsed character data is thus any string of characters which does not contain the start-delimiter of any markup. Character data is any string of characters not including the marked-section-close delimiter, "]]>". For convenience, the single-quote character (') may be represented as "&sq;", and the double-quote character (") as "&dq;".
  - urlDecode
```
public static String urlDecode(String urlString)
```
    A HTML form MIME type string. This type is normally sent from browsers in a POST reply from a HTML form. Each field in the answer is separated by "&" character and the content is encoded using java.net.URLEncoder.encode method, decoded with the InternetCharacterConversion.urlDecode method. Note that this method will not handle the "&" sign, so the string must be tokenized prior to calling this method.
    This utility method decodes a String from a MIME format called "x-www-form-urlencoded" format into a normal String.
    To convert a String to the encoded form, each character is examined in turn:
    - The ASCII characters 'a' through 'z', 'A' through 'Z', and '0' through '9' remain the same.
    - The space character ' ' is converted into a plus sign '+'.
    - All other characters are converted into the 3-character string "%xy", where xy is the two-digit hexadecimal representation of the lower 8-bits of the character.
    Returns:
    the decoded string or null if an error in the encoding exists.
    See Also:
    MimeTypes.HTML_FORM_REPLY_MIME_TYPE
  - urlDecode
```
public static Hashtable<String,String> urlDecode(byte[] data)
```
    A HTML form MIME type reply. This type is normally sent from browsers in a POST reply from a HTML form. Each field in the answer is separated by "&" character and the content is encoded using java.net.URLEncoder.encode method, decoded with the InternetCharacterConversion.urlDecode method.
    This utility method decodes a byte array from a MIME format called "x-www-form-urlencoded" format a series of name/value pairs in a hash table. If several names exist, the last one is retained.
    Note: The case of the name string is retained. The name string is however trimmed of any spaces.
    Returns:
    the decoded name/value pairs or null if an error in the encoding exists.
    See Also:
    MimeTypes.HTML_FORM_REPLY_MIME_TYPE

Class InternetCharacterConversion

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

hexes

Constructor Detail

InternetCharacterConversion

Method Detail

setCodepage

getCodepageString

convertByteToString

convertByteToString

convertStringToByte

convertToHTMLString

convertToHTMLString

stringConvertToHTMLString

convertToXMLString

stringConvertToXMLString

convertToXMLString

urlDecode

urlDecode