Strings (Apache Directory LDAP API Utilities 1.0.0-M15 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.api.util
Class Strings

java.lang.Object
  org.apache.directory.api.util.Strings

public final class Strings
extends Object
extends 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.

Author:: Apache Directory Project

Field Summary
`static byte[]`	`EMPTY_BYTES` A empty byte array
`static boolean[]`	`IS_PRINTABLE_CHAR` A table containing booleans when the corresponding char is printable
`static char[]`	`TO_LOWER_CASE`
`static char[]`	`UPPER_CASE` upperCase = 'A' ..

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, 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, String text)` Check if a text is present at the current position in a buffer.
`static boolean`	`areEquals(String string, int index, String text)` Check if a text is present at the current position in another string.
`static String`	`asciiBytesToString(byte[] bytes)` Thansform an array of ASCII bytes to a string.
`static byte`	`byteAt(byte[] bytes, int index)` Get the byte at a given position in a byte array, checking for limits
`static String`	`centerTrunc(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(String string, int index)` Get the character at a given position in a string, checking for limits
`static byte[]`	`copy(byte[] value)` Copy a byte array into a new byte array
`static String`	`deepTrim(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 String`	`deepTrim(String str, boolean toLowerCase)` Put common code to deepTrim(String) and deepTrimToLower here.
`static String`	`deepTrimToLower(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 String`	`dumpByte(byte octet)` Helper function that dump a byte in hex form
`static 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 String`	`dumpHexPairs(byte[] buffer)` Helper function that dump an array of bytes in hex pair form, without '0x' and space chars
`static boolean`	`equals(String str1, String str2)` Compares two Strings, returning `true` if they are equal.
`static String`	`formatHtml(String source, boolean replaceNl, boolean replaceTag, boolean replaceQuote)` This method is used to insert HTML block dynamically
`static byte[]`	`getBytesUtf8(String string)` Return UTF-8 encoded byte[] representation of a String
`static byte[]`	`getBytesUtf8Ascii(String string)` When the string to convert to bytes is pure ascii, ths is a faster method than the getBytesUtf8.
`static String`	`getDefaultCharsetName()` Get the default charset
`static String`	`getString(byte[] data, int offset, int length, String charset)` From commons-httpclients.
`static String`	`getString(byte[] data, String charset)` From commons-httpclients.
`static String`	`getUUID(long value)` Create a new UUID using a long as the least significant bits
`static boolean`	`isCharASCII(byte[] byteArray, int index, char car)` Test if the current character is equal to a specific character.
`static boolean`	`isCharASCII(String string, int index, char car)` Test if the current character is equal to a specific character.
`static boolean`	`isEmpty(byte[] bytes)` Checks if a bytes array is empty or null.
`static boolean`	`isEmpty(String str)` Checks if a String is empty ("") or null.
`static boolean`	`isIA5String(String str)` Check that a String is a valid IA5String.
`static boolean`	`isNotEmpty(String str)` Checks if a String is not empty ("") and not null.
`static boolean`	`isPrintableString(String str)` Check that a String is a valid PrintableString.
`static boolean`	`isValidUuid(String uuid)` Checks to see if a String is a valid UUID.
`static String`	`listToString(List<?> list)` Utility method that return a String representation of a list
`static String`	`listToString(List<?> list, String tabs)` Utility method that return a String representation of a list
`static String`	`lowerCase(String str)` Converts a String to lower case as per `String.toLowerCase()`.
`static String`	`lowerCaseAscii(String str)` Rewrote the toLowercase method to improve performances.
`static String`	`mapToString(Map<?,?> map)` Utility method that return a String representation of a map.
`static String`	`mapToString(Map<?,?> map, String tabs)` Utility method that return a String representation of a map.
`static String`	`setToString(Set<?> set)` Utility method that return a String representation of a set
`static byte[]`	`toByteArray(String hexString)` Get byte array from hex string
`static String`	`toHexString(byte[] res)` Gets a hex string from byte array.
`static String`	`toLowerCase(String value)` Rewrote the toLowercase method to improve performances.
`static String`	`toUpperCase(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 String`	`trim(String str)` Removes spaces (char <= 32) from both start and ends of this String, handling `null` by returning `null`.
`static String`	`trimConsecutiveToOne(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 String`	`trimLeft(String str)` Removes spaces (char <= 32) from start of this String, handling `null` by returning `null`.
`static void`	`trimLeft(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 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 String`	`trimRight(String str)` Removes spaces (char <= 32) from end of this String, handling `null` by returning `null`.
`static String`	`trimRight(String str, int escapedSpace)` Removes spaces (char <= 32) from end of this String, handling `null` by returning `null`.
`static String`	`trimRight(String string, Position pos)` Removes spaces (char <= 32) from end of this string, handling `null` by returning `null`.
`static String`	`upperCase(String str)` Converts a String to upper case as per `String.toUpperCase()`.
`static String`	`utf8ToString(byte[] bytes)` Return an UTF-8 encoded String
`static String`	`utf8ToString(byte[] bytes, int length)` Return an UTF-8 encoded String
`static String`	`utf8ToString(byte[] bytes, int start, int length)` Return an UTF-8 encoded String
`static byte[]`	`uuidToBytes(String string)` converts the string representation of an UUID to bytes
`static String`	`uuidToString(byte[] bytes)` converts the bytes of a UUID to string

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

IS_PRINTABLE_CHAR

public static final boolean[] IS_PRINTABLE_CHAR

A table containing booleans when the corresponding char is printable

TO_LOWER_CASE

public static final char[] TO_LOWER_CASE

UPPER_CASE

public static final char[] UPPER_CASE

upperCase = 'A' .. 'Z', '0'..'9', '-'

EMPTY_BYTES

public static final byte[] EMPTY_BYTES

A empty byte array

Method Detail

dumpBytes

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

dumpByte

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

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

dumpHexPairs

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

deepTrim

public static String deepTrim(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

deepTrimToLower

public static String deepTrimToLower(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 String deepTrim(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.

trimConsecutiveToOne

public static String trimConsecutiveToOne(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

centerTrunc

public static String centerTrunc(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 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

toByteArray

public static byte[] toByteArray(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 String formatHtml(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

areEquals

public static boolean areEquals(String string,
                                int index,
                                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.

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(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.

utf8ToString

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

utf8ToString

public static String utf8ToString(byte[] bytes,
                                  int start,
                                  int length)

Return an UTF-8 encoded String

Parameters:: bytes - The byte array to be transformed to a String; start - the starting position in the byte array; length - The length of the byte array to be converted
Returns:: A String.

areEquals

public static int areEquals(byte[] bytes,
                            int index,
                            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 int areEquals(char[] chars,
                            int index,
                            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 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 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.

isEmpty

public static boolean isEmpty(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

trim

public static String trim(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"

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