| java.lang.Object
 org.apache.poi.util.StringUtil
| StringUtil | | public class StringUtil (Code) | | Title: String Utility Description: Collection of string handling utilities
author:
Andrew C. Oliver
author:
Sergei Kozello (sergeikozello at mail.ru)
author:
Toshiaki Kamoshida (kamoshida.toshiaki at future dot co dot jp)
since:
May 10, 2002
version:
1.0 |
| Method Summary | |
| public static String | format(String message, Object[] params)
Apply printf() like formatting to a string. | | public static String | getFromCompressedUnicode(byte[] string, int offset, int len)
Read 8 bit data (in ISO-8859-1 codepage) into a (unicode) Java
String and return. | | public static String | getFromUnicodeBE(byte[] string, int offset, int len)
Given a byte array of 16-bit unicode characters in big endian
format (most important byte first), return a Java String representation
of it. | | public static String | getFromUnicodeBE(byte[] string)
Given a byte array of 16-bit unicode characters in big endian
format (most important byte first), return a Java String representation
of it. | | public static String | getFromUnicodeLE(byte[] string, int offset, int len)
Given a byte array of 16-bit unicode characters in Little Endian
format (most important byte last), return a Java String representation
of it. | | public static String | getFromUnicodeLE(byte[] string)
Given a byte array of 16-bit unicode characters in little endian
format (most important byte last), return a Java String representation
of it. | | public static String | getPreferredEncoding()
| | public static boolean | hasMultibyte(String value)
| | public static boolean | isUnicodeString(String value)
| | public static void | putCompressedUnicode(String input, byte[] output, int offset)
Takes a unicode (java) string, and returns it as 8 bit data (in ISO-8859-1
codepage). | | public static void | putUnicodeBE(String input, byte[] output, int offset)
Takes a unicode string, and returns it as big endian (most
important byte first) bytes in the supplied byte array. | | public static void | putUnicodeLE(String input, byte[] output, int offset)
Takes a unicode string, and returns it as little endian (most
important byte last) bytes in the supplied byte array. |
| format | | public static String format(String message, Object[] params)(Code) | | Apply printf() like formatting to a string.
Primarily used for logging.
Parameters:
message - the string with embedded formatting info eg. "This is a test %2.2"
Parameters:
params - array of values to format into the string The formatted string |
| getFromCompressedUnicode | | public static String getFromCompressedUnicode(byte[] string, int offset, int len)(Code) | | Read 8 bit data (in ISO-8859-1 codepage) into a (unicode) Java
String and return.
(In Excel terms, read compressed 8 bit unicode as a string)
Parameters:
string - byte array to read
Parameters:
offset - offset to read byte array
Parameters:
len - length to read byte array String generated String instance by reading byte array |
| getFromUnicodeBE | | public static String getFromUnicodeBE(byte[] string, int offset, int len) throws ArrayIndexOutOfBoundsException, IllegalArgumentException(Code) | | Given a byte array of 16-bit unicode characters in big endian
format (most important byte first), return a Java String representation
of it.
{ 0x00, 0x16 } -0x16
Parameters:
string - the byte array to be converted
Parameters:
offset - the initial offset into the byte array. it is assumed that string[ offset ] and string[ offset + 1 ] contain the first 16-bit unicode character
Parameters:
len - the length of the final string the converted string
exception:
ArrayIndexOutOfBoundsException - if offset is out of bounds for the byte array (i.e., is negative or is greater than or equal to string.length)
exception:
IllegalArgumentException - if len is too large (i.e., there is not enough data in string to create a String of that length) |
| getFromUnicodeBE | | public static String getFromUnicodeBE(byte[] string)(Code) | | Given a byte array of 16-bit unicode characters in big endian
format (most important byte first), return a Java String representation
of it.
{ 0x00, 0x16 } -0x16
Parameters:
string - the byte array to be converted the converted string |
| getFromUnicodeLE | | public static String getFromUnicodeLE(byte[] string, int offset, int len) throws ArrayIndexOutOfBoundsException, IllegalArgumentException(Code) | | Given a byte array of 16-bit unicode characters in Little Endian
format (most important byte last), return a Java String representation
of it.
{ 0x16, 0x00 } -0x16
Parameters:
string - the byte array to be converted
Parameters:
offset - the initial offset into thebyte array. it is assumed that string[ offset ] and string[ offset +1 ] contain the first 16-bit unicode character
Parameters:
len - the length of the final string the converted string
exception:
ArrayIndexOutOfBoundsException - if offset is out of bounds forthe byte array (i.e., is negative or is greater than or equal to string.length)
exception:
IllegalArgumentException - if len is too large (i.e.,there is not enough data in string to create a String of that length) |
| getFromUnicodeLE | | public static String getFromUnicodeLE(byte[] string)(Code) | | Given a byte array of 16-bit unicode characters in little endian
format (most important byte last), return a Java String representation
of it.
{ 0x16, 0x00 } -0x16
Parameters:
string - the byte array to be converted the converted string |
| getPreferredEncoding | | public static String getPreferredEncoding()(Code) | | the encoding we want to use, currently hardcoded to ISO-8859-1 |
| hasMultibyte | | public static boolean hasMultibyte(String value)(Code) | | check the parameter has multibyte character
Parameters:
value - string to check boolean resulttrue:string has at least one multibyte character |
| isUnicodeString | | public static boolean isUnicodeString(String value)(Code) | | Checks to see if a given String needs to be represented as Unicode
Parameters:
value - true if string needs Unicode to be represented. |
| putCompressedUnicode | | public static void putCompressedUnicode(String input, byte[] output, int offset)(Code) | | Takes a unicode (java) string, and returns it as 8 bit data (in ISO-8859-1
codepage).
(In Excel terms, write compressed 8 bit unicode)
Parameters:
input - the String containing the data to be written
Parameters:
output - the byte array to which the data is to be written
Parameters:
offset - an offset into the byte arrat at which the data is start when written |
| putUnicodeBE | | public static void putUnicodeBE(String input, byte[] output, int offset)(Code) | | Takes a unicode string, and returns it as big endian (most
important byte first) bytes in the supplied byte array.
(In Excel terms, write uncompressed unicode)
Parameters:
input - the String containing the unicode data to be written
Parameters:
output - the byte array to hold the uncompressed unicode, should be twice the length of the String
Parameters:
offset - the offset to start writing into the byte array |
| putUnicodeLE | | public static void putUnicodeLE(String input, byte[] output, int offset)(Code) | | Takes a unicode string, and returns it as little endian (most
important byte last) bytes in the supplied byte array.
(In Excel terms, write uncompressed unicode)
Parameters:
input - the String containing the unicode data to be written
Parameters:
output - the byte array to hold the uncompressed unicode, should be twice the length of the String
Parameters:
offset - the offset to start writing into the byte array |
|
|