Package org.apache.poi.util
Class StringUtil
java.lang.Object
org.apache.poi.util.StringUtil
Collection of string handling utilities
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn Iterator over an array of Strings. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic intcountMatches(CharSequence haystack, char needle) Count number of occurrences of needle in haystack Has same signature as org.apache.commons.lang3.StringUtils#countMatchesstatic booleanendsWithIgnoreCase(String haystack, String suffix) Tests if the string ends with the specified suffix, ignoring case consideration.static intgetEncodedSize(String value) static StringgetFromCompressedUnicode(byte[] string, int offset, int len) Read 8 bit data (in ISO-8859-1 codepage) into a (unicode) Java String and return.static StringgetFromUnicodeLE(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 StringgetFromUnicodeLE(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 StringgetFromUnicodeLE0Terminated(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 Stringstatic byte[]getToUnicodeLE(String string) Convert String to 16-bit unicode characters in little endian formatstatic booleanhasMultibyte(String value) check the parameter has multibyte characterstatic booleanisUnicodeString(String value) Checks to see if a given String needs to be represented as Unicodestatic booleanisUpperCase(char c) static Stringstatic Stringstatic Stringstatic voidmapMsCodepoint(int msCodepoint, int unicodeCodepoint) static StringmapMsCodepointString(String string) Some strings may contain encoded characters of the unicode private use area.static voidputCompressedUnicode(String input, byte[] output, int offset) Takes a unicode (java) string, and returns it as 8 bit data (in ISO-8859-1 codepage).static voidputCompressedUnicode(String input, LittleEndianOutput out) static voidputUnicodeLE(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.static voidputUnicodeLE(String input, LittleEndianOutput out) static StringreadCompressedUnicode(LittleEndianInput in, int nChars) static StringreadUnicodeLE(LittleEndianInput in, int nChars) static StringInputStream in is expected to contain: ushort nChars byte is16BitFlag byte[]/char[] characterData For this encoding, the is16BitFlag is always present even if nChars==0.static StringreadUnicodeString(LittleEndianInput in, int nChars) InputStream in is expected to contain: byte is16BitFlag byte[]/char[] characterData For this encoding, the is16BitFlag is always present even if nChars==0.static booleanstartsWithIgnoreCase(String haystack, String prefix) Tests if the string starts with the specified prefix, ignoring case consideration.static StringtoLowerCase(char c) static StringtoUpperCase(char c) static voidwriteUnicodeString(LittleEndianOutput out, String value) OutputStream out will get: ushort nChars byte is16BitFlag byte[]/char[] characterData For this encoding, the is16BitFlag is always present even if nChars==0.static voidwriteUnicodeStringFlagAndData(LittleEndianOutput out, String value) OutputStream out will get: byte is16BitFlag byte[]/char[] characterData For this encoding, the is16BitFlag is always present even if nChars==0.
-
Field Details
-
ISO_8859_1
-
UTF16LE
-
UTF8
-
WIN_1252
-
BIG5
-
-
Method Details
-
getFromUnicodeLE
public static String getFromUnicodeLE(byte[] string, int offset, int len) throws ArrayIndexOutOfBoundsException, IllegalArgumentException 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 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- Returns:
- the converted string, never
null. - Throws:
ArrayIndexOutOfBoundsException- if offset is out of bounds for the byte array (i.e., is negative or is greater than or equal to string.length)IllegalArgumentException- if len is too large (i.e., there is not enough data in string to create a String of that length)
-
getFromUnicodeLE
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- Returns:
- the converted string, never
null
-
getToUnicodeLE
Convert String to 16-bit unicode characters in little endian format- Parameters:
string- the string- Returns:
- the byte array of 16-bit unicode characters
-
getFromCompressedUnicode
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 readoffset- offset to read byte arraylen- length to read byte array- Returns:
- String generated String instance by reading byte array
-
readCompressedUnicode
-
readUnicodeString
InputStream in is expected to contain:- ushort nChars
- byte is16BitFlag
- byte[]/char[] characterData
This structure is also known as a XLUnicodeString.
-
readUnicodeString
InputStream in is expected to contain:- byte is16BitFlag
- byte[]/char[] characterData
This method should be used when the nChars field is not stored as a ushort immediately before the is16BitFlag. Otherwise,readUnicodeString(LittleEndianInput)can be used. -
writeUnicodeString
OutputStream out will get:- ushort nChars
- byte is16BitFlag
- byte[]/char[] characterData
-
writeUnicodeStringFlagAndData
OutputStream out will get:- byte is16BitFlag
- byte[]/char[] characterData
This method should be used when the nChars field is not stored as a ushort immediately before the is16BitFlag. Otherwise,writeUnicodeString(LittleEndianOutput, String)can be used. -
getEncodedSize
- Returns:
- the number of bytes that would be written by
writeUnicodeString(LittleEndianOutput, String)
-
putCompressedUnicode
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 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
-
putCompressedUnicode
-
putUnicodeLE
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 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
-
putUnicodeLE
-
readUnicodeLE
-
getPreferredEncoding
- Returns:
- the encoding we want to use, currently hardcoded to ISO-8859-1
-
hasMultibyte
check the parameter has multibyte character- Parameters:
value- string to check- Returns:
- boolean result true:string has at least one multibyte character
-
isUnicodeString
Checks to see if a given String needs to be represented as Unicode- Parameters:
value- The string to look at.- Returns:
- true if string needs Unicode to be represented.
-
startsWithIgnoreCase
Tests if the string starts with the specified prefix, ignoring case consideration. -
endsWithIgnoreCase
Tests if the string ends with the specified suffix, ignoring case consideration. -
toLowerCase
-
toUpperCase
-
isUpperCase
-
mapMsCodepointString
Some strings may contain encoded characters of the unicode private use area. Currently the characters of the symbol fonts are mapped to the corresponding characters in the normal unicode range.- Parameters:
string- the original string- Returns:
- the string with mapped characters
- See Also:
-
mapMsCodepoint
public static void mapMsCodepoint(int msCodepoint, int unicodeCodepoint) -
join
-
join
-
join
-
countMatches
Count number of occurrences of needle in haystack Has same signature as org.apache.commons.lang3.StringUtils#countMatches- Parameters:
haystack- the CharSequence to check, may be nullneedle- the character to count the quantity of- Returns:
- the number of occurrences, 0 if the CharSequence is null
-
getFromUnicodeLE0Terminated
public static String getFromUnicodeLE0Terminated(byte[] string, int offset, int len) throws ArrayIndexOutOfBoundsException, IllegalArgumentException Given a byte array of 16-bit unicode characters in Little Endian format (most important byte last), return a Java String representation of it. Scans the byte array for two continous 0 bytes and returns the string before.#61881: there seem to be programs out there, which write the 0-termination also at the beginning of the string. Check if the next two bytes contain a valid ascii char and correct the _recdata with a '?' char
- Parameters:
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 max. length of the final string- Returns:
- the converted string, never
null. - Throws:
ArrayIndexOutOfBoundsException- if offset is out of bounds for the byte array (i.e., is negative or is greater than or equal to string.length)IllegalArgumentException- if len is too large (i.e., there is not enough data in string to create a String of that length)
-