com.aoindustries.util

Class StringUtility

java.lang.Object

com.aoindustries.util.StringUtility

public final class StringUtility
extends Object

Author:

AO Industries, Inc.

Method Summary

Modifier and Type	Method and Description
static int	compareToIgnoreCaseCarefulEquals(String S1, String S2) Compares two strings in a case insensitive manner.
static boolean	containsIgnoreCase(String line, String word)
static byte[]	convertByteArrayFromHex(char[] hex)
static int	convertIntArrayFromHex(char[] hex)
static long	convertLongArrayFromHex(char[] hex)
static String	convertToHex(byte[] bytes)
static void	convertToHex(byte[] bytes, Appendable out)
static String	convertToHex(int value) Converts an int to a full 8-character hex code.
static void	convertToHex(int value, Appendable out) Converts an int to a full 8-character hex code.
static String	convertToHex(long value) Converts a long integer to a full 16-character hex code.
static void	convertToHex(long value, Appendable out) Converts a long integer to a full 16-character hex code.
static int	countOccurrences(byte[] buff, int len, String word) Counts how many times a word appears in a line.
static int	countOccurrences(byte[] buff, String word) Counts how many times a word appears in a line.
static int	countOccurrences(String line, String word) Counts how many times a word appears in a line.
static String	firstLineOnly(String value, int maxCharacters) Returns the first line only, and only up to the maximum number of characters.
static String	getApproximateBitRate(long bit_rate) Gets the approximate bit rate (where k=1000) in this format: x xx xxx x.x k xx.x k xxx k x.x M xx.x M xxx M x.x G xx.x G xxx G x.x T xx.x T xxx T xxx...
static String	getApproximateSize(long size) Gets the approximate size (where k=1024) of a file in this format: x byte(s) xx bytes xxx bytes x.x k xx.x k xxx k x.x M xx.x M xxx M x.x G xx.x G xxx G x.x T xx.x T xxx T xxx...
static String	getDecimalTimeLengthString(long time)
static String	getDecimalTimeLengthString(long time, boolean alwaysShowMillis)
static int	getHex(char ch) Converts one hex digit to an integer
static char	getHexChar(int v) Gets the hexadecimal character for the low-order four bits of the provided int.
static String	getMonth(int month) Deprecated. This method is not locale-aware, is no longer used, and will be removed.
static String	getTimeLengthString(long time)
static int	indexOf(String S, char[] chars) Finds the first occurrence of any of the supplied characters
static int	indexOf(String S, char[] chars, int start) Finds the first occurrence of any of the supplied characters starting at the specified index.
static int	indexOf(String source, String target, int fromIndex, int toIndex) Finds the next of a substring like regular String.indexOf, but stops at a certain maximum index.
static String	join(Iterable<?> objects, String delimiter) Joins the string representation of objects on the provided delimiter.
static <A extends Appendable> A	join(Iterable<?> objects, String delimiter, A out) Joins the string representation of objects on the provided delimiter.
static String	join(Object[] objects, String delimiter) Joins the string representation of objects on the provided delimiter.
static <A extends Appendable> A	join(Object[] objects, String delimiter, A out) Joins the string representation of objects on the provided delimiter.
static String	nullIfEmpty(String value) Returns null if the string is null or empty.
static void	replace(StringBuffer sb, String find, String replacement) Replaces all occurrences of a String with a String.
static void	replace(StringBuilder sb, String find, String replacement) Replaces all occurrences of a String with a String.
static String	replace(String string, char ch, String replacement) Replaces all occurrences of a character with a String
static String	replace(String string, String find, String replacement) Replaces all occurrences of a String with a String Please consider the variant with the Appendable for higher performance.
static void	replace(String string, String find, String replacement, Appendable out) Replaces all occurrences of a String with a String, appends the replacement to out.
static List<String>	splitLines(String S) Splits a String into lines on any '\n' characters.
static String[]	splitString(String line) Splits a String into a String[].
static List<String>	splitString(String line, char delim) Splits a string on the given delimiter.
static int	splitString(String line, char[][][] buff) Splits a String into a String[].
static <C extends Collection<String>> C	splitString(String line, char delim, C words) Splits a string on the given delimiter.
static List<String>	splitString(String line, int begin, int end, char delim) Splits a string on the given delimiter over the given range.
static <C extends Collection<String>> C	splitString(String line, int begin, int end, char delim, C words) Splits a string on the given delimiter over the given range.
static List<String>	splitString(String line, String delim)
static int	splitString(String line, String[][] buff) Splits a String into a String[].
static List<String>	splitStringCommaSpace(String line) Splits a string into multiple words on either whitespace or commas
static String	wordWrap(String string, int width) Deprecated. Use new version with Appendable for higher performance
static void	wordWrap(String string, int width, Appendable out) Word wraps a String to be no longer than the provided number of characters wide.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMonth

@Deprecated
public static String getMonth(int month)

Deprecated. This method is not locale-aware, is no longer used, and will be removed.

join

public static String join(Iterable<?> objects,
                          String delimiter)
                   throws ConcurrentModificationException

Joins the string representation of objects on the provided delimiter. The iteration will be performed twice. Once to compute the total length of the resulting string, and the second to build the result.

Throws:

ConcurrentModificationException - if iteration is not consistent between passes

See Also:

join(java.lang.Iterable, java.lang.String, java.lang.Appendable), join(java.lang.Object[], java.lang.String)

join

public static <A extends Appendable> A join(Iterable<?> objects,
                                            String delimiter,
                                            A out)
                                     throws IOException

Joins the string representation of objects on the provided delimiter.

Throws:

IOException

See Also:

join(java.lang.Iterable, java.lang.String), join(java.lang.Object[], java.lang.String, java.lang.Appendable)

join

public static String join(Object[] objects,
                          String delimiter)
                   throws ConcurrentModificationException

Joins the string representation of objects on the provided delimiter. The iteration will be performed twice. Once to compute the total length of the resulting string, and the second to build the result.

Throws:

ConcurrentModificationException - if iteration is not consistent between passes

See Also:

join(java.lang.Object[], java.lang.String, java.lang.Appendable), join(java.lang.Iterable, java.lang.String)

join

public static <A extends Appendable> A join(Object[] objects,
                                            String delimiter,
                                            A out)
                                     throws IOException

Joins the string representation of objects on the provided delimiter.

Throws:

IOException

See Also:

join(java.lang.Object[], java.lang.String), join(java.lang.Iterable, java.lang.String, java.lang.Appendable)

containsIgnoreCase

public static boolean containsIgnoreCase(String line,
                                         String word)

countOccurrences

public static int countOccurrences(byte[] buff,
                                   int len,
                                   String word)

Counts how many times a word appears in a line. Case insensitive matching.

countOccurrences

public static int countOccurrences(byte[] buff,
                                   String word)

Counts how many times a word appears in a line. Case insensitive matching.

countOccurrences

public static int countOccurrences(String line,
                                   String word)

Counts how many times a word appears in a line. Case insensitive matching.

getTimeLengthString

public static String getTimeLengthString(long time)

getDecimalTimeLengthString

public static String getDecimalTimeLengthString(long time)

getDecimalTimeLengthString

public static String getDecimalTimeLengthString(long time,
                                                boolean alwaysShowMillis)

indexOf

public static int indexOf(String S,
                          char[] chars)

Finds the first occurrence of any of the supplied characters

Parameters:

S - the String to search

chars - the characters to look for

Returns:

the index of the first occurrence of -1 if none found

indexOf

public static int indexOf(String S,
                          char[] chars,
                          int start)

Finds the first occurrence of any of the supplied characters starting at the specified index.

Parameters:

S - the String to search

chars - the characters to look for

start - the starting index.

Returns:

the index of the first occurrence of -1 if none found

replace

public static String replace(String string,
                             char ch,
                             String replacement)

Replaces all occurrences of a character with a String

replace

public static String replace(String string,
                             String find,
                             String replacement)

Replaces all occurrences of a String with a String Please consider the variant with the Appendable for higher performance.

replace

public static void replace(String string,
                           String find,
                           String replacement,
                           Appendable out)
                    throws IOException

Replaces all occurrences of a String with a String, appends the replacement to out.

Throws:

IOException

replace

public static void replace(StringBuffer sb,
                           String find,
                           String replacement)

Replaces all occurrences of a String with a String.

replace

public static void replace(StringBuilder sb,
                           String find,
                           String replacement)

Replaces all occurrences of a String with a String.

splitLines

public static List<String> splitLines(String S)

Splits a String into lines on any '\n' characters. Also removes any ending '\r' characters if present

splitString

public static String[] splitString(String line)

Splits a String into a String[].

splitString

public static int splitString(String line,
                              char[][][] buff)

Splits a String into a String[].

splitString

public static int splitString(String line,
                              String[][] buff)

Splits a String into a String[].

splitString

public static List<String> splitString(String line,
                                       char delim)

Splits a string on the given delimiter. Does include all empty elements on the split.

Returns:

the modifiable list from the split

splitString

public static <C extends Collection<String>> C splitString(String line,
                                                           char delim,
                                                           C words)

Splits a string on the given delimiter. Does include all empty elements on the split.

Parameters:

words - the words will be added to this collection.

Returns:

the collection provided in words parameter

splitString

public static List<String> splitString(String line,
                                       int begin,
                                       int end,
                                       char delim)

Splits a string on the given delimiter over the given range. Does include all empty elements on the split.

Returns:

the modifiable list from the split

splitString

public static <C extends Collection<String>> C splitString(String line,
                                                           int begin,
                                                           int end,
                                                           char delim,
                                                           C words)

Splits a string on the given delimiter over the given range. Does include all empty elements on the split.

Parameters:

words - the words will be added to this collection.

Returns:

the collection provided in words parameter

splitString

public static List<String> splitString(String line,
                                       String delim)

splitStringCommaSpace

public static List<String> splitStringCommaSpace(String line)

Splits a string into multiple words on either whitespace or commas

Parameters:

line - java.lang.String

Returns:

java.lang.String[]

wordWrap

@Deprecated
public static String wordWrap(String string,
                                          int width)

Deprecated. Use new version with Appendable for higher performance

Word wraps a String to be no longer than the provided number of characters wide.

wordWrap

public static void wordWrap(String string,
                            int width,
                            Appendable out)
                     throws IOException

Word wraps a String to be no longer than the provided number of characters wide. TODO: Make this more efficient by eliminating the internal use of substring.

Throws:

IOException

getHexChar

public static char getHexChar(int v)

Gets the hexadecimal character for the low-order four bits of the provided int.

getHex

public static int getHex(char ch)
                  throws IllegalArgumentException

Converts one hex digit to an integer

Throws:

IllegalArgumentException

convertToHex

public static void convertToHex(byte[] bytes,
                                Appendable out)
                         throws IOException

Throws:

IOException

convertToHex

public static String convertToHex(byte[] bytes)

convertByteArrayFromHex

public static byte[] convertByteArrayFromHex(char[] hex)

convertToHex

public static void convertToHex(int value,
                                Appendable out)
                         throws IOException

Converts an int to a full 8-character hex code.

Throws:

IOException

convertToHex

public static String convertToHex(int value)

Converts an int to a full 8-character hex code.

convertIntArrayFromHex

public static int convertIntArrayFromHex(char[] hex)

convertToHex

public static void convertToHex(long value,
                                Appendable out)
                         throws IOException

Converts a long integer to a full 16-character hex code.

Throws:

IOException

convertToHex

public static String convertToHex(long value)

Converts a long integer to a full 16-character hex code.

convertLongArrayFromHex

public static long convertLongArrayFromHex(char[] hex)

getApproximateSize

public static String getApproximateSize(long size)

Gets the approximate size (where k=1024) of a file in this format: x byte(s) xx bytes xxx bytes x.x k xx.x k xxx k x.x M xx.x M xxx M x.x G xx.x G xxx G x.x T xx.x T xxx T xxx... T

getApproximateBitRate

public static String getApproximateBitRate(long bit_rate)

Gets the approximate bit rate (where k=1000) in this format: x xx xxx x.x k xx.x k xxx k x.x M xx.x M xxx M x.x G xx.x G xxx G x.x T xx.x T xxx T xxx... T

compareToIgnoreCaseCarefulEquals

public static int compareToIgnoreCaseCarefulEquals(String S1,
                                                   String S2)

Compares two strings in a case insensitive manner. However, if they are considered equals in the case-insensitive manner, the case sensitive comparison is done.

indexOf

public static int indexOf(String source,
                          String target,
                          int fromIndex,
                          int toIndex)

Finds the next of a substring like regular String.indexOf, but stops at a certain maximum index. Like substring, will look up to the character one before toIndex.

firstLineOnly

public static String firstLineOnly(String value,
                                   int maxCharacters)

Returns the first line only, and only up to the maximum number of characters. If the value is modified, will append a horizontal ellipsis (Unicode 0x2026).

nullIfEmpty

public static String nullIfEmpty(String value)

Returns null if the string is null or empty.