StringTools (Apache Directory Protocol Ldap Shared 0.9.15 API)

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
  org.apache.directory.shared.ldap.util.StringTools

public class StringTools
extends java.lang.Object
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: 798875 $
Author:: Apache Directory Project

Field Summary
`static java.lang.String`	`EMPTY` The empty String `""`.
`static byte[]`	`EMPTY_BYTES` The empty byte[]
`static int`	`NOT_EQUAL`

Constructor Summary
`StringTools()`

Method Summary
`static int`	`areEquals(byte[] bytes, int index, byte[] bytes2)` Check if a text is present at the current position in a buffer.
`static int`	`areEquals(byte[] bytes, int index, java.lang.String text)` Check if a text is present at the current position in a buffer.
`static int`	`areEquals(char[] chars, int index, char[] chars2)` Check if a text is present at the current position in a buffer.
`static int`	`areEquals(char[] chars, int index, java.lang.String text)` Check if a text is present at the current position in a buffer.
`static boolean`	`areEquals(java.lang.String string, int index, java.lang.String text)` Check if a text is present at the current position in another string.
`static java.lang.String`	`asciiBytesToString(byte[] bytes)` Thansform an array of ASCII bytes to a string.
`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 str, int head, int tail)` Truncates large Strings showing a portion of the String's head and tail with the center cut out and replaced with '...'.
`static char`	`charAt(java.lang.String string, int index)` Get the character at a given position in a string, checking fo limits
`static byte[]`	`charToBytes(char car)` Return the Unicode char which is coded in the bytes at the given position.
`static int`	`collectEscapedHexBytes(ByteBuffer bb, java.lang.String str, int index)` Collects an hex sequence from a string, and returns the value as an integer, after having modified the initial value (the escaped hex value is transsformed to the byte it represents).
`static byte[]`	`convertEscapedHex(java.lang.String str)` Convert an escaoed list of bytes to a byte[]
`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`	`decodeEscapedHex(java.lang.String str)` Decodes sequences of escaped hex within an attribute's value into a UTF-8 String.
`static java.lang.String`	`decodeHexString(java.lang.String str)` Decodes values of attributes in the DN encoded in hex into a UTF-8 String.
`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 java.lang.String`	`dumpHexPairs(byte[] buffer)` Helper function that dump an array of bytes in hex pair form, without '0x' and space chars
`static java.lang.String`	`dumpObject(java.lang.Object object)` Helper method to render an object which can be a String or a byte[]
`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 source, boolean replaceNl, boolean replaceTag, boolean replaceQuote)` 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.lang.String`	`getDefaultCharsetName()` Get the default charset
`static byte`	`getHexValue(byte high, byte low)` Translate two bytes to an hex value.
`static byte`	`getHexValue(char c)` Return an hex value from a sinle char The char must be in [0-9a-fA-F]
`static byte`	`getHexValue(char high, char low)` Translate two chars to an hex value.
`static java.util.List<java.lang.String>`	`getPaths(java.lang.String paths, java.io.FileFilter 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 java.lang.String`	`getType(byte[] bytes)` Build an AttributeType froma byte array.
`static boolean`	`isAlpha(byte c)` Test if the current byte is an Alpha character : <alpha> ::= [0x41-0x5A] \| [0x61-0x7A]
`static boolean`	`isAlpha(char c)` Test if the current character is an Alpha character : <alpha> ::= [0x41-0x5A] \| [0x61-0x7A]
`static boolean`	`isAlphaASCII(byte[] bytes, int index)` Test if the current character is an Alpha character : <alpha> ::= [0x41-0x5A] \| [0x61-0x7A]
`static boolean`	`isAlphaASCII(char[] chars, int index)` Test if the current character is an Alpha character : <alpha> ::= [0x41-0x5A] \| [0x61-0x7A]
`static boolean`	`isAlphaASCII(java.lang.String string, int index)` Test if the current character is an Alpha character : <alpha> ::= [0x41-0x5A] \| [0x61-0x7A]
`static boolean`	`isAlphaDigit(java.lang.String string, int index)` Check if the current character is an 7 bits ASCII CHAR (between 0 and 127).
`static boolean`	`isAlphaDigitMinus(byte[] bytes, 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`	`isAlphaDigitMinus(java.lang.String string, int index)` Check if the current character is an 7 bits ASCII CHAR (between 0 and 127).
`static boolean`	`isAlphaLowercaseASCII(java.lang.String string, int index)` Test if the current character is a lowercased Alpha character : <alpha> ::= [0x61-0x7A]
`static boolean`	`isAlphaUppercaseASCII(java.lang.String string, int index)` Test if the current character is a uppercased Alpha character : <alpha> ::= [0x61-0x7A]
`static boolean`	`isBit(java.lang.String string, int index)` Test if the current character is a bit, ie 0 or 1.
`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`	`isCharASCII(java.lang.String string, int index, char car)` Test if the current character is equal to a specific character.
`static boolean`	`isDigit(byte[] bytes)` Test if the current character is a digit <digit> ::= '0' \| '1' \| '2' \| '3' \| '4' \| '5' \| '6' \| '7' \| '8' \| '9'
`static boolean`	`isDigit(byte[] bytes, int index)` Test if the current character is a digit <digit> ::= '0' \| '1' \| '2' \| '3' \| '4' \| '5' \| '6' \| '7' \| '8' \| '9'
`static boolean`	`isDigit(char car)` Test if the current character is a digit <digit> ::= '0' \| '1' \| '2' \| '3' \| '4' \| '5' \| '6' \| '7' \| '8' \| '9'
`static boolean`	`isDigit(char[] chars)` Test if the current character is a digit <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 <digit> ::= '0' \| '1' \| '2' \| '3' \| '4' \| '5' \| '6' \| '7' \| '8' \| '9'
`static boolean`	`isDigit(java.lang.String string, int index)` Test if the current character is a digit <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[] bytes, int index)` Check if the current character is an Hex Char <hex> ::= [0x30-0x39] \| [0x41-0x46] \| [0x61-0x66]
`static boolean`	`isHex(char[] chars, int index)` Check if the current character is an Hex Char <hex> ::= [0x30-0x39] \| [0x41-0x46] \| [0x61-0x66]
`static boolean`	`isHex(java.lang.String string, int index)` Check if the current character is an Hex Char <hex> ::= [0x30-0x39] \| [0x41-0x46] \| [0x61-0x66]
`static boolean`	`isIA5String(java.lang.String str)` Check that a String is a valid IA5String.
`static boolean`	`isICharASCII(byte[] bytes, int index, char car)` Test if the current character is equal to a specific character.
`static boolean`	`isICharASCII(java.lang.String string, int index, char car)` Test if the current character is equal to a specific character.
`static boolean`	`isNotEmpty(java.lang.String str)` Checks if a String is not empty ("") and not null.
`static boolean`	`isPrintableString(java.lang.String str)` Check that a String is a valid PrintableString.
`static boolean`	`isUnicodeSubset(char c)` Check if the current char is in the unicodeSubset : all chars but '\0', '(', ')', '*' and '\'
`static boolean`	`isUnicodeSubset(java.lang.String str, int pos)` Check if the current char is in the unicodeSubset : all chars but '\0', '(', ')', '*' and '\'
`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`	`lowerCaseAscii(java.lang.String str)` Rewrote the toLowercase method to improve performances.
`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 hexString)` Get byte array from hex string
`static java.lang.String`	`toHexString(byte[] res)` Gets a hex string from byte array.
`static java.lang.String`	`toLowerCase(java.lang.String value)` Rewrote the toLowercase method to improve performances.
`static java.lang.String`	`toUpperCase(java.lang.String value)` Rewrote the toLowercase method to improve performances.
`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 void`	`trimLeft(byte[] bytes, Position pos)` Removes spaces (char <= 32) from a position in 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 void`	`trimLeft(java.lang.String string, Position pos)` Removes spaces (char <= 32) from a position in this array, 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 java.lang.String`	`trimRight(byte[] bytes, Position pos)` Removes spaces (char <= 32) from end of this string, 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`	`trimRight(java.lang.String str, int escapedSpace)` Removes spaces (char <= 32) from end of this String, handling `null` by returning `null`.
`static java.lang.String`	`trimRight(java.lang.String string, Position pos)` 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
`static java.lang.String`	`utf8ToString(byte[] bytes, int start, 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

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 final 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 final 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 final 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 final 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:: TODO Replace the toCharArray() by substring manipulations

centerTrunc

public static final java.lang.String centerTrunc(java.lang.String str,
                                                 int head,
                                                 int 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:: str - the string to truncate; head - the amount of the head to display; tail - the amount of the tail to display
Returns:: the center truncated string

toHexString

public static final java.lang.String toHexString(byte[] res)

Gets a hex string from byte array.

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

toLowerCase

public static final java.lang.String toLowerCase(java.lang.String value)

Rewrote the toLowercase method to improve performances. In Ldap, attributesType are supposed to use ASCII chars : 'a'-'z', 'A'-'Z', '0'-'9', '.' and '-' only.

Parameters:: value - The String to lowercase
Returns:: The lowercase string

toUpperCase

public static final java.lang.String toUpperCase(java.lang.String value)

Rewrote the toLowercase method to improve performances. In Ldap, attributesType are supposed to use ASCII chars : 'a'-'z', 'A'-'Z', '0'-'9', '.' and '-' only.

Parameters:: value - The String to uppercase
Returns:: The uppercase string

toByteArray

public static final byte[] toByteArray(java.lang.String hexString)

Get byte array from hex string

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

formatHtml

public static final java.lang.String formatHtml(java.lang.String source,
                                                boolean replaceNl,
                                                boolean replaceTag,
                                                boolean replaceQuote)

This method is used to insert HTML block dynamically

Parameters:: source - the HTML code to be processes; replaceNl - if true '\n' will be replaced by <br>; replaceTag - if true '<' will be replaced by < and '>' will be replaced by >; replaceQuote - if true '\"' will be replaced by "
Returns:: the formated html block

getRegex

public static final 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.

Parameters:: initialPattern - the initial fragment before wildcards; anyPattern - fragments surrounded by wildcards if any; finalPattern - the final fragment after last wildcard if any
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 final 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.

Parameters:: ldapRegex - the substring match expression
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 final java.util.List<java.lang.String> getPaths(java.lang.String paths,
                                                              java.io.FileFilter 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:: paths - a set of paths delimited using the OS path separator; filter - a FileFilter used to filter the return set
Returns:: the filter accepted path component Strings in the order encountered

dumpByte

public static final 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 final char dumpHex(byte hex)

Helper function that returns a char from an hex

Parameters:: hex - The hex to dump
Returns:: A char representation of the hex

dumpBytes

public static final 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

dumpObject

public static java.lang.String dumpObject(java.lang.Object object)

Helper method to render an object which can be a String or a byte[]

Returns:: A string representing the object

dumpHexPairs

public static final java.lang.String dumpHexPairs(byte[] buffer)

Helper function that dump an array of bytes in hex pair form, without '0x' and space chars

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

bytesToChar

public static final 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 final 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 final 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 final 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 final 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 final byte[] charToBytes(char car)

Return the Unicode char which is coded in the bytes at the given position.

Parameters:: car - The character to be transformed to an array of bytes
Returns:: The byte array representing the char TODO : Should stop after the third byte, as a char is only 2 bytes long.

countChars

public static final 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 final int areEquals(byte[] bytes,
                                  int index,
                                  java.lang.String text)

Check if a text is present at the current position in a buffer.

Parameters:: bytes - 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 final int areEquals(char[] chars,
                                  int index,
                                  java.lang.String text)

Check if a text is present at the current position in a buffer.

Parameters:: chars - 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 final int areEquals(char[] chars,
                                  int index,
                                  char[] chars2)

Check if a text is present at the current position in a buffer.

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

areEquals

public static final boolean areEquals(java.lang.String string,
                                      int index,
                                      java.lang.String text)

Check if a text is present at the current position in another string.

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

areEquals

public static final int areEquals(byte[] bytes,
                                  int index,
                                  byte[] bytes2)

Check if a text is present at the current position in a buffer.

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

isCharASCII

public static final 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 final 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.

isCharASCII

public static final boolean isCharASCII(java.lang.String string,
                                        int index,
                                        char car)

Test if the current character is equal to a specific character.

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

isICharASCII

public static final boolean isICharASCII(java.lang.String string,
                                         int index,
                                         char car)

Test if the current character is equal to a specific character.

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

isICharASCII

public static final boolean isICharASCII(byte[] bytes,
                                         int index,
                                         char car)

Test if the current character is equal to a specific character.

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

isBit

public static final boolean isBit(java.lang.String string,
                                  int index)

Test if the current character is a bit, ie 0 or 1.

Parameters:: string - The String which contains the data; index - Current position in the string
Returns:: true if the current character is a bit (0 or 1)

charAt

public static final char charAt(java.lang.String string,
                                int index)

Get the character at a given position in a string, checking fo limits

Parameters:: string - The string which contains the data; index - Current position in the string
Returns:: The character ar the given position, or '\0' if something went wrong

getHexValue

public static byte getHexValue(char high,
                               char low)

Translate two chars to an hex value. The chars must be in [a-fA-F0-9]

Parameters:: high - The high value; low - The low value
Returns:: A byte representation of the two chars

getHexValue

public static byte getHexValue(byte high,
                               byte low)

Translate two bytes to an hex value. The bytes must be in [0-9a-fA-F]

Parameters:: high - The high value; low - The low value
Returns:: A byte representation of the two bytes

getHexValue

public static byte getHexValue(char c)

Return an hex value from a sinle char The char must be in [0-9a-fA-F]

Parameters:: c - The char we want to convert
Returns:: A byte between 0 and 15

isHex

public static final boolean isHex(byte[] bytes,
                                  int index)

Check if the current character is an Hex Char <hex> ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66]

Parameters:: bytes - 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 final boolean isHex(char[] chars,
                                  int index)

Check if the current character is an Hex Char <hex> ::= [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

isHex

public static final boolean isHex(java.lang.String string,
                                  int index)

Check if the current character is an Hex Char <hex> ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66]

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

isDigit

public static final boolean isDigit(byte[] bytes)

Test if the current character is a digit <digit> ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

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

isDigit

public static final boolean isDigit(char car)

Test if the current character is a digit <digit> ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

Parameters:: car - the character to test
Returns:: true if the character is a Digit

isAlpha

public static final boolean isAlpha(byte c)

Test if the current byte is an Alpha character : <alpha> ::= [0x41-0x5A] | [0x61-0x7A]

Parameters:: c - The byte to test
Returns:: true if the byte is an Alpha character

isAlpha

public static final boolean isAlpha(char c)

Test if the current character is an Alpha character : <alpha> ::= [0x41-0x5A] | [0x61-0x7A]

Parameters:: c - The char to test
Returns:: true if the character is an Alpha character

isAlphaASCII

public static final boolean isAlphaASCII(byte[] bytes,
                                         int index)

Test if the current character is an Alpha character : <alpha> ::= [0x41-0x5A] | [0x61-0x7A]

Parameters:: bytes - 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 final boolean isAlphaASCII(char[] chars,
                                         int index)

Test if the current character is an Alpha character : <alpha> ::= [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

isAlphaASCII

public static final boolean isAlphaASCII(java.lang.String string,
                                         int index)

Test if the current character is an Alpha character : <alpha> ::= [0x41-0x5A] | [0x61-0x7A]

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

isAlphaLowercaseASCII

public static final boolean isAlphaLowercaseASCII(java.lang.String string,
                                                  int index)

Test if the current character is a lowercased Alpha character :
<alpha> ::= [0x61-0x7A]

Parameters:: string - The string which contains the data; index - Current position in the string
Returns:: true if the current character is a lower Alpha character

isAlphaUppercaseASCII

public static final boolean isAlphaUppercaseASCII(java.lang.String string,
                                                  int index)

Test if the current character is a uppercased Alpha character :
<alpha> ::= [0x61-0x7A]

Parameters:: string - The string which contains the data; index - Current position in the string
Returns:: true if the current character is a lower Alpha character

isDigit

public static final boolean isDigit(byte[] bytes,
                                    int index)

Test if the current character is a digit <digit> ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

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

isDigit

public static final boolean isDigit(char[] chars,
                                    int index)

Test if the current character is a digit <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 final boolean isDigit(java.lang.String string,
                                    int index)

Test if the current character is a digit <digit> ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

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

isDigit

public static final boolean isDigit(char[] chars)

Test if the current character is a digit <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

isAlphaDigit

public static final boolean isAlphaDigit(java.lang.String string,
                                         int index)

Check if the current character is an 7 bits ASCII CHAR (between 0 and 127). <char> ::= <alpha> | <digit>

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

isAlphaDigitMinus

public static final boolean isAlphaDigitMinus(byte[] bytes,
                                              int index)

Check if the current character is an 7 bits ASCII CHAR (between 0 and 127). <char> ::= <alpha> | <digit> | '-'

Parameters:: bytes - 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 final boolean isAlphaDigitMinus(char[] chars,
                                              int index)

Check if the current character is an 7 bits ASCII CHAR (between 0 and 127). <char> ::= <alpha> | <digit> | '-'

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.

isAlphaDigitMinus

public static final boolean isAlphaDigitMinus(java.lang.String string,
                                              int index)

Check if the current character is an 7 bits ASCII CHAR (between 0 and 127). <char> ::= <alpha> | <digit> | '-'

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

isEmpty

public static final 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 final 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 final 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 final 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 final 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"

Parameters:: bytes - the byte array to be trimmed, may be null
Returns:: the trimmed byte array