|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.util.StringUtil
public class StringUtil
Title: String Utility Description: Collection of string handling utilities
| Method Summary | |
|---|---|
static java.lang.String |
format(java.lang.String message,
java.lang.Object[] params)
Apply printf() like formatting to a string. |
static java.lang.String |
getFromCompressedUnicode(byte[] string,
int offset,
int len)
Read 8 bit data (in ISO-8859-1 codepage) into a (unicode) Java String and return. |
static java.lang.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. |
static java.lang.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. |
static java.lang.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. |
static java.lang.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. |
static java.lang.String |
getPreferredEncoding()
|
static boolean |
hasMultibyte(java.lang.String value)
check the parameter has multibyte character |
static boolean |
isUnicodeString(java.lang.String value)
Checks to see if a given String needs to be represented as Unicode |
static void |
putCompressedUnicode(java.lang.String input,
byte[] output,
int offset)
Takes a unicode (java) string, and returns it as 8 bit data (in ISO-8859-1 codepage). |
static void |
putUnicodeBE(java.lang.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. |
static void |
putUnicodeLE(java.lang.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. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public static java.lang.String getFromUnicodeLE(byte[] string,
int offset,
int len)
throws java.lang.ArrayIndexOutOfBoundsException,
java.lang.IllegalArgumentException
string - the byte array to be convertedoffset - the initial offset into the
byte array. it is assumed that string[ offset ] and string[ offset +
1 ] contain the first 16-bit unicode characterlen - the length of the final string
java.lang.ArrayIndexOutOfBoundsException - if offset is out of bounds for
the byte array (i.e., is negative or is greater than or equal to
string.length)
java.lang.IllegalArgumentException - if len is too large (i.e.,
there is not enough data in string to create a String of that
length)public static java.lang.String getFromUnicodeLE(byte[] string)
string - the byte array to be converted
public static java.lang.String getFromUnicodeBE(byte[] string,
int offset,
int len)
throws java.lang.ArrayIndexOutOfBoundsException,
java.lang.IllegalArgumentException
string - the byte array to be convertedoffset - the initial offset into the
byte array. it is assumed that string[ offset ] and string[ offset +
1 ] contain the first 16-bit unicode characterlen - the length of the final string
java.lang.ArrayIndexOutOfBoundsException - if offset is out of bounds for
the byte array (i.e., is negative or is greater than or equal to
string.length)
java.lang.IllegalArgumentException - if len is too large (i.e.,
there is not enough data in string to create a String of that
length)public static java.lang.String getFromUnicodeBE(byte[] string)
string - the byte array to be converted
public static java.lang.String getFromCompressedUnicode(byte[] string,
int offset,
int len)
string - byte array to readoffset - offset to read byte arraylen - length to read byte array
public static void putCompressedUnicode(java.lang.String input,
byte[] output,
int offset)
input - the String containing the data to be writtenoutput - the byte array to which the data is to be writtenoffset - an offset into the byte arrat at which the data is start
when written
public static void putUnicodeLE(java.lang.String input,
byte[] output,
int offset)
input - the String containing the unicode data to be writtenoutput - the byte array to hold the uncompressed unicode, should be twice the length of the Stringoffset - the offset to start writing into the byte array
public static void putUnicodeBE(java.lang.String input,
byte[] output,
int offset)
input - the String containing the unicode data to be writtenoutput - the byte array to hold the uncompressed unicode, should be twice the length of the Stringoffset - the offset to start writing into the byte array
public static java.lang.String format(java.lang.String message,
java.lang.Object[] params)
message - the string with embedded formatting info
eg. "This is a test %2.2"params - array of values to format into the string
public static java.lang.String getPreferredEncoding()
public static boolean hasMultibyte(java.lang.String value)
value - string to check
public static boolean isUnicodeString(java.lang.String value)
value -
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||