Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.directory.shared.ldap.util
Class StringTools

java.lang.Object
  extended byorg.apache.directory.shared.ldap.util.StringTools
public class StringTools
extends java.lang.Object

Various string manipulation methods that are more efficient then chaining string operations: all is done in the same buffer without creating a bunch of string objects.

Version:
$Rev: 379008 $
Author:
Apache Directory Project

Field Summary
static boolean[] ALPHA
           ::= [0x41-0x5A] | [0x61-0x7A]
static boolean[] CHAR
           | | '-'
static boolean[] DIGIT
          '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
static java.lang.String EMPTY
          The empty String "".
static byte[] EMPTY_BYTES
          The empty byte[]
static byte[] HEX_VALUE
           ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66]
static int NOT_EQUAL
           
 
Constructor Summary
StringTools()
           
 
Method Summary
static int areEquals(byte[] byteArray, int index, byte[] byteArray2)
          Check if a text is present at the current position in a buffer.
static int areEquals(byte[] byteArray, int index, java.lang.String text)
          Check if a text is present at the current position in a buffer.
static int areEquals(char[] charArray, int index, char[] charArray2)
          Check if a text is present at the current position in a buffer.
static int areEquals(char[] charArray, int index, java.lang.String text)
          Check if a text is present at the current position in a buffer.
static char bytesToChar(byte[] bytes)
          Return the Unicode char which is coded in the bytes at position 0.
static char bytesToChar(byte[] bytes, int pos)
          Return the Unicode char which is coded in the bytes at the given position.
static java.lang.String centerTrunc(java.lang.String a_str, int a_head, int a_tail)
          Truncates large Strings showing a portion of the String's head and tail with the center cut out and replaced with '...'.
static byte[] charToBytes(char car)
          Return the Unicode char which is coded in the bytes at the given position.
static int countBytes(char[] chars)
          Count the number of bytes included in the given char[].
static int countBytesPerChar(byte[] bytes, int pos)
          Count the number of bytes needed to return an Unicode char.
static int countChars(byte[] bytes)
          Count the number of chars included in the given byte[].
static int countNbBytesPerChar(char car)
          Return the number of bytes that hold an Unicode char.
static java.lang.String deepTrim(java.lang.String string)
          A deep trim of a string remove whitespace from the ends as well as excessive whitespace within the inside of the string between non-whitespace characters.
static java.lang.String deepTrim(java.lang.String str, boolean toLowerCase)
          Put common code to deepTrim(String) and deepTrimToLower here.
static java.lang.String deepTrimToLower(java.lang.String string)
          This does the same thing as a trim but we also lowercase the string while performing the deep trim within the same buffer.
static java.lang.String dumpByte(byte octet)
          Helper function that dump a byte in hex form
static java.lang.String dumpBytes(byte[] buffer)
          Helper function that dump an array of bytes in hex form
static char dumpHex(byte hex)
          Helper function that returns a char from an hex
static boolean equals(java.lang.String str1, java.lang.String str2)
           Compares two Strings, returning true if they are equal.
static java.lang.String formatHtml(java.lang.String a_source, boolean a_bReplaceNl, boolean a_bReplaceTag, boolean a_bReplaceQuote)
          This method is used to insert HTML block dynamically
static byte[] getBytesUtf8(java.lang.String string)
          Return UTF-8 encoded byte[] representation of a String
static java.util.List getPaths(java.lang.String a_paths, java.io.FileFilter a_filter)
          Splits apart a OS separator delimited set of paths in a string into multiple Strings.
static java.util.regex.Pattern getRegex(java.lang.String ldapRegex)
          Generates a regular expression from an LDAP substring match expression by parsing out the supplied string argument.
static java.util.regex.Pattern getRegex(java.lang.String initialPattern, java.lang.String[] anyPattern, java.lang.String finalPattern)
          Creates a regular expression from an LDAP substring assertion filter specification.
static boolean isAlphaASCII(byte[] byteArray, int index)
          Test if the current character is an Alpha character : ::= [0x41-0x5A] | [0x61-0x7A]
static boolean isAlphaASCII(char[] chars, int index)
          Test if the current character is an Alpha character : ::= [0x41-0x5A] | [0x61-0x7A]
static boolean isAlphaDigitMinus(byte[] byteArray, int index)
          Check if the current character is an 7 bits ASCII CHAR (between 0 and 127).
static boolean isAlphaDigitMinus(char[] chars, int index)
          Check if the current character is an 7 bits ASCII CHAR (between 0 and 127).
static boolean isCharASCII(byte[] byteArray, int index, char car)
          Test if the current character is equal to a specific character.
static boolean isCharASCII(char[] chars, int index, char car)
          Test if the current character is equal to a specific character.
static boolean isDigit(byte[] byteArray)
          Test if the current character is a digit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
static boolean isDigit(byte[] byteArray, int index)
          Test if the current character is a digit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
static boolean isDigit(char[] chars)
          Test if the current character is a digit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
static boolean isDigit(char[] chars, int index)
          Test if the current character is a digit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
static boolean isEmpty(byte[] bytes)
          Checks if a bytes array is empty or null.
static boolean isEmpty(java.lang.String str)
           Checks if a String is empty ("") or null.
static boolean isHex(byte[] byteArray, int index)
          Check if the current character is an Hex Char ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66]
static boolean isHex(char[] chars, int index)
          Check if the current character is an Hex Char ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66]
static boolean isNotEmpty(java.lang.String str)
           Checks if a String is not empty ("") and not null.
static java.lang.String listToString(java.util.List list)
          Utility method that return a String representation of a list
static java.lang.String listToString(java.util.List list, java.lang.String tabs)
          Utility method that return a String representation of a list
static java.lang.String lowerCase(java.lang.String str)
           Converts a String to lower case as per String.toLowerCase().
static java.lang.String mapToString(java.util.Map map)
          Utility method that return a String representation of a map.
static java.lang.String mapToString(java.util.Map map, java.lang.String tabs)
          Utility method that return a String representation of a map.
static byte[] toByteArray(java.lang.String a_hexString)
          Get byte array from hex string
static java.lang.String toHexString(byte[] a_res)
          Gets a hex string from byte array.
static byte[] trim(byte[] bytes)
           Removes spaces (char <= 32) from both start and ends of this bytes array, handling null by returning null.
static java.lang.String trim(java.lang.String str)
           Removes spaces (char <= 32) from both start and ends of this String, handling null by returning null.
static java.lang.String trimConsecutiveToOne(java.lang.String str, char ch)
          Trims several consecutive characters into one.
static int trimLeft(byte[] bytes, int pos)
           Removes spaces (char <= 32) from start of this array, handling null by returning null.
static int trimLeft(char[] chars, int pos)
           Removes spaces (char <= 32) from start of this array, handling null by returning null.
static java.lang.String trimLeft(java.lang.String str)
           Removes spaces (char <= 32) from start of this String, handling null by returning null.
static int trimRight(byte[] bytes, int pos)
           Removes spaces (char <= 32) from end of this array, handling null by returning null.
static int trimRight(char[] chars, int pos)
           Removes spaces (char <= 32) from end of this array, handling null by returning null.
static java.lang.String trimRight(java.lang.String str)
           Removes spaces (char <= 32) from end of this String, handling null by returning null.
static java.lang.String upperCase(java.lang.String str)
           Converts a String to upper case as per String.toUpperCase().
static java.lang.String utf8ToString(byte[] bytes)
          Return an UTF-8 encoded String
static java.lang.String utf8ToString(byte[] bytes, int length)
          Return an UTF-8 encoded String
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALPHA

public static final boolean[] ALPHA
::= [0x41-0x5A] | [0x61-0x7A]

CHAR

public static final boolean[] CHAR
| | '-'

DIGIT

public static final boolean[] DIGIT
'0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

HEX_VALUE

public static final byte[] HEX_VALUE
::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66]

NOT_EQUAL

public static final int NOT_EQUAL
See Also:
Constant Field Values

EMPTY

public static final java.lang.String EMPTY
The empty String "".

Since:
2.0
See Also:
Constant Field Values

EMPTY_BYTES

public static final byte[] EMPTY_BYTES
The empty byte[]

Constructor Detail

StringTools

public StringTools()
Method Detail

trimConsecutiveToOne

public static java.lang.String trimConsecutiveToOne(java.lang.String str,
                                                    char ch)
Trims several consecutive characters into one.

Parameters:
str - the string to trim consecutive characters of
ch - the character to trim down
Returns:
the newly trimmed down string

deepTrim

public static java.lang.String deepTrim(java.lang.String string)
A deep trim of a string remove whitespace from the ends as well as excessive whitespace within the inside of the string between non-whitespace characters. A deep trim reduces internal whitespace down to a single space to perserve the whitespace separated tokenization order of the String.

Parameters:
string - the string to deep trim.
Returns:
the trimmed string.

deepTrimToLower

public static java.lang.String deepTrimToLower(java.lang.String string)
This does the same thing as a trim but we also lowercase the string while performing the deep trim within the same buffer. This saves us from having to create multiple String and StringBuffer objects and is much more efficient.

See Also:
deepTrim( String )

deepTrim

public static java.lang.String deepTrim(java.lang.String str,
                                        boolean toLowerCase)
Put common code to deepTrim(String) and deepTrimToLower here.

Parameters:
str - the string to deep trim
toLowerCase - how to normalize for case: upper or lower
Returns:
the deep trimmed string
See Also:
deepTrim( String )

centerTrunc

public static java.lang.String centerTrunc(java.lang.String a_str,
                                           int a_head,
                                           int a_tail)
Truncates large Strings showing a portion of the String's head and tail with the center cut out and replaced with '...'. Also displays the total length of the truncated string so size of '...' can be interpreted. Useful for large strings in UIs or hex dumps to log files.

Parameters:
a_str - the string to truncate
a_head - the amount of the head to display
a_tail - the amount of the tail to display
Returns:
the center truncated string

toHexString

public static java.lang.String toHexString(byte[] a_res)
Gets a hex string from byte array.

Parameters:
a_res - the byte array
Returns:
the hex string representing the binary values in the array

toByteArray

public static byte[] toByteArray(java.lang.String a_hexString)
Get byte array from hex string

Parameters:
a_hexString - the hex string to convert to a byte array
Returns:
the byte form of the hex string.

formatHtml

public static java.lang.String formatHtml(java.lang.String a_source,
                                          boolean a_bReplaceNl,
                                          boolean a_bReplaceTag,
                                          boolean a_bReplaceQuote)
This method is used to insert HTML block dynamically

Parameters:
a_source - the HTML code to be processes
a_bReplaceNl - if true '\n' will be replaced by
a_bReplaceTag - if true '<' will be replaced by < and '>' will be replaced by >
a_bReplaceQuote - if true '\"' will be replaced by "
Returns:
the formated html block

getRegex

public static java.util.regex.Pattern getRegex(java.lang.String initialPattern,
                                               java.lang.String[] anyPattern,
                                               java.lang.String finalPattern)
                                        throws java.util.regex.PatternSyntaxException
Creates a regular expression from an LDAP substring assertion filter specification.

Returns:
the regular expression for the substring match filter
Throws:
RESyntaxException - if a syntactically correct regular expression cannot be compiled
java.util.regex.PatternSyntaxException

getRegex

public static java.util.regex.Pattern getRegex(java.lang.String ldapRegex)
                                        throws java.util.regex.PatternSyntaxException
Generates a regular expression from an LDAP substring match expression by parsing out the supplied string argument.

Returns:
the regular expression for the substring match filter
Throws:
RESyntaxException - if a syntactically correct regular expression cannot be compiled
java.util.regex.PatternSyntaxException

getPaths

public static java.util.List getPaths(java.lang.String a_paths,
                                      java.io.FileFilter a_filter)
Splits apart a OS separator delimited set of paths in a string into multiple Strings. File component path strings are returned within a List in the order they are found in the composite path string. Optionally, a file filter can be used to filter out path strings to control the components returned. If the filter is null all path components are returned.

Parameters:
a_paths - a set of paths delimited using the OS path separator
a_filter - a FileFilter used to filter the return set
Returns:
the filter accepted path component Strings in the order encountered

dumpByte

public static java.lang.String dumpByte(byte octet)
Helper function that dump a byte in hex form

Parameters:
octet - The byte to dump
Returns:
A string representation of the byte

dumpHex

public static char dumpHex(byte hex)
Helper function that returns a char from an hex

Returns:
A char representation of the hex

dumpBytes

public static java.lang.String dumpBytes(byte[] buffer)
Helper function that dump an array of bytes in hex form

Parameters:
buffer - The bytes array to dump
Returns:
A string representation of the array of bytes

bytesToChar

public static char bytesToChar(byte[] bytes)
Return the Unicode char which is coded in the bytes at position 0.

Parameters:
bytes - The byte[] represntation of an Unicode string.
Returns:
The first char found.

countBytesPerChar

public static int countBytesPerChar(byte[] bytes,
                                    int pos)
Count the number of bytes needed to return an Unicode char. This can be from 1 to 6.

Parameters:
bytes - The bytes to read
pos - Position to start counting. It must be a valid start of a encoded char !
Returns:
The number of bytes to create a char, or -1 if the encoding is wrong. TODO : Should stop after the third byte, as a char is only 2 bytes long.

countNbBytesPerChar

public static int countNbBytesPerChar(char car)
Return the number of bytes that hold an Unicode char.

Parameters:
car - The character to be decoded
Returns:
The number of bytes to hold the char. TODO : Should stop after the third byte, as a char is only 2 bytes long.

countBytes

public static int countBytes(char[] chars)
Count the number of bytes included in the given char[].

Parameters:
chars - The char array to decode
Returns:
The number of bytes in the char array

bytesToChar

public static char bytesToChar(byte[] bytes,
                               int pos)
Return the Unicode char which is coded in the bytes at the given position.

Parameters:
bytes - The byte[] represntation of an Unicode string.
pos - The current position to start decoding the char
Returns:
The decoded char, or -1 if no char can be decoded TODO : Should stop after the third byte, as a char is only 2 bytes long.

charToBytes

public static byte[] charToBytes(char car)
Return the Unicode char which is coded in the bytes at the given position.

Returns:
The decoded char, or -1 if no char can be decoded TODO : Should stop after the third byte, as a char is only 2 bytes long.

countChars

public static int countChars(byte[] bytes)
Count the number of chars included in the given byte[].

Parameters:
bytes - The byte array to decode
Returns:
The number of char in the byte array

areEquals

public static int areEquals(byte[] byteArray,
                            int index,
                            java.lang.String text)
Check if a text is present at the current position in a buffer.

Parameters:
byteArray - The buffer which contains the data
index - Current position in the buffer
text - The text we want to check
Returns:
true if the buffer contains the text.

areEquals

public static int areEquals(char[] charArray,
                            int index,
                            java.lang.String text)
Check if a text is present at the current position in a buffer.

Parameters:
charArray - The buffer which contains the data
index - Current position in the buffer
text - The text we want to check
Returns:
true if the buffer contains the text.

areEquals

public static int areEquals(char[] charArray,
                            int index,
                            char[] charArray2)
Check if a text is present at the current position in a buffer.

Parameters:
charArray - The buffer which contains the data
index - Current position in the buffer
charArray2 - The text we want to check
Returns:
true if the buffer contains the text.

areEquals

public static int areEquals(byte[] byteArray,
                            int index,
                            byte[] byteArray2)
Check if a text is present at the current position in a buffer.

Parameters:
byteArray - The buffer which contains the data
index - Current position in the buffer
byteArray2 - The text we want to check
Returns:
true if the buffer contains the text.

isCharASCII

public static boolean isCharASCII(byte[] byteArray,
                                  int index,
                                  char car)
Test if the current character is equal to a specific character. This function works only for character between 0 and 127, as it does compare a byte and a char (which is 16 bits wide)

Parameters:
byteArray - The buffer which contains the data
index - Current position in the buffer
car - The character we want to compare with the current buffer position
Returns:
true if the current character equals the given character.

isCharASCII

public static boolean isCharASCII(char[] chars,
                                  int index,
                                  char car)
Test if the current character is equal to a specific character.

Parameters:
chars - The buffer which contains the data
index - Current position in the buffer
car - The character we want to compare with the current buffer position
Returns:
true if the current character equals the given character.

isHex

public static boolean isHex(byte[] byteArray,
                            int index)
Check if the current character is an Hex Char ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66]

Parameters:
byteArray - The buffer which contains the data
index - Current position in the buffer
Returns:
true if the current character is a Hex Char

isHex

public static boolean isHex(char[] chars,
                            int index)
Check if the current character is an Hex Char ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66]

Parameters:
chars - The buffer which contains the data
index - Current position in the buffer
Returns:
true if the current character is a Hex Char

isDigit

public static boolean isDigit(byte[] byteArray)
Test if the current character is a digit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

Parameters:
byteArray - The buffer which contains the data
Returns:
true if the current character is a Digit

isAlphaASCII

public static boolean isAlphaASCII(byte[] byteArray,
                                   int index)
Test if the current character is an Alpha character : ::= [0x41-0x5A] | [0x61-0x7A]

Parameters:
byteArray - The buffer which contains the data
index - Current position in the buffer
Returns:
true if the current character is an Alpha character

isAlphaASCII

public static boolean isAlphaASCII(char[] chars,
                                   int index)
Test if the current character is an Alpha character : ::= [0x41-0x5A] | [0x61-0x7A]

Parameters:
chars - The buffer which contains the data
index - Current position in the buffer
Returns:
true if the current character is an Alpha character

isDigit

public static boolean isDigit(byte[] byteArray,
                              int index)
Test if the current character is a digit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

Parameters:
byteArray - The buffer which contains the data
index - Current position in the buffer
Returns:
true if the current character is a Digit

isDigit

public static boolean isDigit(char[] chars,
                              int index)
Test if the current character is a digit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

Parameters:
chars - The buffer which contains the data
index - Current position in the buffer
Returns:
true if the current character is a Digit

isDigit

public static boolean isDigit(char[] chars)
Test if the current character is a digit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

Parameters:
chars - The buffer which contains the data
Returns:
true if the current character is a Digit

isAlphaDigitMinus

public static boolean isAlphaDigitMinus(byte[] byteArray,
                                        int index)
Check if the current character is an 7 bits ASCII CHAR (between 0 and 127). ::= | | '-'

Parameters:
byteArray - The buffer which contains the data
index - Current position in the buffer
Returns:
The position of the next character, if the current one is a CHAR.

isAlphaDigitMinus

public static boolean isAlphaDigitMinus(char[] chars,
                                        int index)
Check if the current character is an 7 bits ASCII CHAR (between 0 and 127). ::= | | '-'

Parameters:
chars - The buffer which contains the data
index - Current position in the buffer
Returns:
The position of the next character, if the current one is a CHAR.

isEmpty

public static boolean isEmpty(java.lang.String str)

Checks if a String is empty ("") or null. 

  StringUtils.isEmpty(null)      = true
  StringUtils.isEmpty("")        = true
  StringUtils.isEmpty(" ")       = false
  StringUtils.isEmpty("bob")     = false
  StringUtils.isEmpty("  bob  ") = false

NOTE: This method changed in Lang version 2.0. It no longer trims the String. That functionality is available in isBlank().

Parameters:
str - the String to check, may be null
Returns:
true if the String is empty or null

isEmpty

public static boolean isEmpty(byte[] bytes)
Checks if a bytes array is empty or null.

Parameters:
bytes - The bytes array to check, may be null
Returns:
true if the bytes array is empty or null

isNotEmpty

public static boolean isNotEmpty(java.lang.String str)

Checks if a String is not empty ("") and not null. 

  StringUtils.isNotEmpty(null)      = false
  StringUtils.isNotEmpty("")        = false
  StringUtils.isNotEmpty(" ")       = true
  StringUtils.isNotEmpty("bob")     = true
  StringUtils.isNotEmpty("  bob  ") = true

Parameters:
str - the String to check, may be null
Returns:
true if the String is not empty and not null

trim

public static java.lang.String trim(java.lang.String str)

Removes spaces (char <= 32) from both start and ends of this String, handling null by returning null.

Trim removes start and end characters <= 32. 
  StringUtils.trim(null)          = null
  StringUtils.trim("")            = ""
  StringUtils.trim("     ")       = ""
  StringUtils.trim("abc")         = "abc"
  StringUtils.trim("    abc    ") = "abc"

Parameters:
str - the String to be trimmed, may be null
Returns:
the trimmed string, null if null String input

trim

public static byte[] trim(byte[] bytes)

Removes spaces (char <= 32) from both start and ends of this bytes array, handling null by returning null.

Trim removes start and end characters <= 32. 
  StringUtils.trim(null)          = null
  StringUtils.trim("")            = ""
  StringUtils.trim("     ")       = ""
  StringUtils.trim("abc")         = "abc"
  StringUtils.trim("    abc    ") = "abc"

Returns:
the trimmed string, null if null String input

trimLeft

public static java.lang.String trimLeft(java.lang.String str)

Removes spaces (char <= 32) from start of this String, handling null by returning null.

Trim removes start characters <= 32. 
  StringUtils.trimLeft(null)          = null
  StringUtils.trimLeft("")            = ""
  StringUtils.trimLeft("     ")       = ""
  StringUtils.trimLeft("abc")         = "abc"
  StringUtils.trimLeft("    abc    ") = "abc    "

Parameters:
str - the String to be trimmed, may be null
Returns:
the trimmed string, null if null String input

trimLeft

public static int trimLeft(char[] chars,
                           int pos)

Removes spaces (char <= 32) from start of this array, handling null by returning null.

Trim removes start characters <= 32. 
  StringUtils.trimLeft(null)          = null
  StringUtils.trimLeft("")            = ""
  StringUtils.trimLeft("     ")       = ""
  StringUtils.trimLeft("abc")         = "abc"
  StringUtils.trimLeft("    abc    ") = "abc    "

Parameters:
chars - the chars array to be trimmed, may be null
Returns:
the position of the first char which is not a space, or the last position of the array.

trimLeft

public static int trimLeft(byte[] bytes,
                           int pos)

Removes spaces (char <= 32) from start of this array, handling null by returning null.

Trim removes start characters <= 32. 
  StringUtils.trimLeft(null)          = null
  StringUtils.trimLeft("")            = ""
  StringUtils.trimLeft("     ")       = ""
  StringUtils.trimLeft("abc")         = "abc"
  StringUtils.trimLeft("    abc    ") = "abc    "

Parameters:
bytes - the byte array to be trimmed, may be null
Returns:
the position of the first byte which is not a space, or the last position of the array.

trimRight

public static java.lang.String trimRight(java.lang.String str)

Removes spaces (char <= 32) from end of this String, handling null by returning null.

Trim removes start characters <= 32. 
  StringUtils.trimRight(null)          = null
  StringUtils.trimRight("")            = ""
  StringUtils.trimRight("     ")       = ""
  StringUtils.trimRight("abc")         = "abc"
  StringUtils.trimRight("    abc    ") = "    abc"

Parameters:
str - the String to be trimmed, may be null
Returns:
the trimmed string, null if null String input

trimRight

public static int trimRight(char[] chars,
                            int pos)

Removes spaces (char <= 32) from end of this array, handling null by returning null.

Trim removes start characters <= 32. 
  StringUtils.trimRight(null)          = null
  StringUtils.trimRight("")            = ""
  StringUtils.trimRight("     ")       = ""
  StringUtils.trimRight("abc")         = "abc"
  StringUtils.trimRight("    abc    ") = "    abc"

Parameters:
chars - the chars array to be trimmed, may be null
Returns:
the position of the first char which is not a space, or the last position of the array.

trimRight

public static int trimRight(byte[] bytes,
                            int pos)

Removes spaces (char <= 32) from end of this array, handling null by returning null.

Trim removes start characters <= 32. 
  StringUtils.trimRight(null)          = null
  StringUtils.trimRight("")            = ""
  StringUtils.trimRight("     ")       = ""
  StringUtils.trimRight("abc")         = "abc"
  StringUtils.trimRight("    abc    ") = "    abc"

Parameters:
bytes - the chars array to be trimmed, may be null
Returns:
the position of the first char which is not a space, or the last position of the array.

upperCase

public static java.lang.String upperCase(java.lang.String str)

Converts a String to upper case as per String.toUpperCase().

A null input String returns null. 

  StringUtils.upperCase(null)  = null
  StringUtils.upperCase("")    = ""
  StringUtils.upperCase("aBc") = "ABC"

Parameters:
str - the String to upper case, may be null
Returns:
the upper cased String, null if null String input

lowerCase

public static java.lang.String lowerCase(java.lang.String str)

Converts a String to lower case as per String.toLowerCase().

A null input String returns null. 

  StringUtils.lowerCase(null)  = null
  StringUtils.lowerCase("")    = ""
  StringUtils.lowerCase("aBc") = "abc"

Parameters:
str - the String to lower case, may be null
Returns:
the lower cased String, null if null String input

equals

public static boolean equals(java.lang.String str1,
                             java.lang.String str2)

Compares two Strings, returning true if they are equal.

nulls are handled without exceptions. Two null references are considered to be equal. The comparison is case sensitive. 

  StringUtils.equals(null, null)   = true
  StringUtils.equals(null, "abc")  = false
  StringUtils.equals("abc", null)  = false
  StringUtils.equals("abc", "abc") = true
  StringUtils.equals("abc", "ABC") = false

Parameters:
str1 - the first String, may be null
str2 - the second String, may be null
Returns:
true if the Strings are equal, case sensitive, or both null
See Also:
String.equals(Object)

utf8ToString

public static java.lang.String utf8ToString(byte[] bytes)
Return an UTF-8 encoded String

Parameters:
bytes - The byte array to be transformed to a String
Returns:
A String.

utf8ToString

public static java.lang.String utf8ToString(byte[] bytes,
                                            int length)
Return an UTF-8 encoded String

Parameters:
bytes - The byte array to be transformed to a String
length - The length of the byte array to be converted
Returns:
A String.

getBytesUtf8

public static byte[] getBytesUtf8(java.lang.String string)
Return UTF-8 encoded byte[] representation of a String

Parameters:
string - The string to be transformed to a byte array
Returns:
The transformed byte array

listToString

public static java.lang.String listToString(java.util.List list)
Utility method that return a String representation of a list

Parameters:
list - The list to transform to a string
Returns:
A csv string

listToString

public static java.lang.String listToString(java.util.List list,
                                            java.lang.String tabs)
Utility method that return a String representation of a list

Parameters:
list - The list to transform to a string
Returns:
A csv string

mapToString

public static java.lang.String mapToString(java.util.Map map)
Utility method that return a String representation of a map. The elements will be represented as "key = value"

Parameters:
map - The map to transform to a string
Returns:
A csv string

mapToString

public static java.lang.String mapToString(java.util.Map map,
                                           java.lang.String tabs)
Utility method that return a String representation of a map. The elements will be represented as "key = value"

Parameters:
map - The map to transform to a string
Returns:
A csv string
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2003-2006 . All Rights Reserved.