org.eclipse.jetty.util

Class StringUtil

java.lang.Object

org.eclipse.jetty.util.StringUtil

public class StringUtil
extends Object

Fast String Utilities. These string utilities provide both convenience methods and performance improvements over most standard library versions. The main aim of the optimizations is to avoid object creation unless absolutely required.

Field Summary

Fields

Modifier and Type	Field and Description
static String	__ISO_8859_1
static Charset	__ISO_8859_1_CHARSET Deprecated. Use StandardCharsets.ISO_8859_1
static String	__LINE_SEPARATOR
static Charset	__US_ASCII_CHARSET Deprecated. Use StandardCharsets.US_ASCII
static String	__UTF16
static Charset	__UTF16_CHARSET Deprecated. Use StandardCharsets.UTF_16
static String	__UTF8
static Charset	__UTF8_CHARSET Deprecated. Use StandardCharsets.UTF_8
static String	ALL_INTERFACES
static String	CRLF
static char[]	lowercases

Constructor Summary

Constructors

Constructor and Description
StringUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	append(StringBuilder buf, byte b, int base) append hex digit
static void	append(StringBuilder buf, String s, int offset, int length) Append substring to StringBuilder
static void	append2digits(StringBuffer buf, int i)
static void	append2digits(StringBuilder buf, int i)
static String[]	arrayFromString(String s)
static String	asciiToLowerCase(String s) fast lower case conversion.
static boolean	endsWithIgnoreCase(String s, String w)
static boolean	equals(String s, char[] buf, int offset, int length)
static byte[]	getBytes(String s)
static byte[]	getBytes(String s, String charset)
static byte[]	getUtf8Bytes(String s)
static int	indexFrom(String s, String chars) returns the next index of a character from the chars string
static boolean	isBlank(String str) Test if a string is null or only has whitespace characters in it.
static boolean	isNotBlank(String str) Test if a string is not null and contains at least 1 non-whitespace characters in it.
static boolean	isUTF8(String charset)
static String	nonNull(String s) Return a non null string.
static String	normalizeCharset(String s) Convert alternate charset names (eg utf8) to normalized name (eg UTF-8).
static String	normalizeCharset(String s, int offset, int length) Convert alternate charset names (eg utf8) to normalized name (eg UTF-8).
static String	printable(byte[] b)
static String	printable(String name)
static String	replace(String s, String sub, String with) replace substrings within string.
static String	sidBytesToString(byte[] sidBytes) Converts a binary SID to a string SID http://en.wikipedia.org/wiki/Security_Identifier S-1-IdentifierAuthority-SubAuthority1-SubAuthority2-...-SubAuthorityn
static byte[]	sidStringToBytes(String sidString) Converts a string SID to a binary SID http://en.wikipedia.org/wiki/Security_Identifier S-1-IdentifierAuthority-SubAuthority1-SubAuthority2-...-SubAuthorityn
static boolean	startsWithIgnoreCase(String s, String w)
static int	toInt(String string) Convert String to an integer.
static long	toLong(String string) Convert String to an long.
static String	toString(byte[] b, int offset, int length, String charset)
static String	toUTF8String(byte[] b, int offset, int length)
static String	truncate(String str, int maxSize) Truncate a string to a max size.
static String	unquote(String s) Remove single or double quotes.

Methods inherited from class java.lang.Object

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

Field Detail

ALL_INTERFACES

public static final String ALL_INTERFACES

See Also:

Constant Field Values

CRLF

public static final String CRLF

See Also:

Constant Field Values

__LINE_SEPARATOR

public static final String __LINE_SEPARATOR

__ISO_8859_1

public static final String __ISO_8859_1

See Also:

Constant Field Values

__UTF8

public static final String __UTF8

See Also:

Constant Field Values

__UTF16

public static final String __UTF16

See Also:

Constant Field Values

__UTF8_CHARSET

@Deprecated
public static final Charset __UTF8_CHARSET

Deprecated. Use StandardCharsets.UTF_8

__ISO_8859_1_CHARSET

@Deprecated
public static final Charset __ISO_8859_1_CHARSET

Deprecated. Use StandardCharsets.ISO_8859_1

__UTF16_CHARSET

@Deprecated
public static final Charset __UTF16_CHARSET

Deprecated. Use StandardCharsets.UTF_16

__US_ASCII_CHARSET

@Deprecated
public static final Charset __US_ASCII_CHARSET

Deprecated. Use StandardCharsets.US_ASCII

lowercases

public static final char[] lowercases

Constructor Detail

StringUtil

public StringUtil()

Method Detail

normalizeCharset

public static String normalizeCharset(String s)

Convert alternate charset names (eg utf8) to normalized name (eg UTF-8).

normalizeCharset

public static String normalizeCharset(String s,
                      int offset,
                      int length)

Convert alternate charset names (eg utf8) to normalized name (eg UTF-8).

asciiToLowerCase

public static String asciiToLowerCase(String s)

fast lower case conversion. Only works on ascii (not unicode)

Parameters:

s - the string to convert

Returns:

a lower case version of s

startsWithIgnoreCase

public static boolean startsWithIgnoreCase(String s,
                           String w)

endsWithIgnoreCase

public static boolean endsWithIgnoreCase(String s,
                         String w)

indexFrom

public static int indexFrom(String s,
            String chars)

returns the next index of a character from the chars string

replace

public static String replace(String s,
             String sub,
             String with)

replace substrings within string.

unquote

public static String unquote(String s)

Remove single or double quotes.

append

public static void append(StringBuilder buf,
          String s,
          int offset,
          int length)

Append substring to StringBuilder

Parameters:

buf - StringBuilder to append to

s - String to append from

offset - The offset of the substring

length - The length of the substring

append

public static void append(StringBuilder buf,
          byte b,
          int base)

append hex digit

append2digits

public static void append2digits(StringBuffer buf,
                 int i)

append2digits

public static void append2digits(StringBuilder buf,
                 int i)

nonNull

public static String nonNull(String s)

Return a non null string.

Parameters:

s - String

Returns:

The string passed in or empty string if it is null.

equals

public static boolean equals(String s,
             char[] buf,
             int offset,
             int length)

toUTF8String

public static String toUTF8String(byte[] b,
                  int offset,
                  int length)

toString

public static String toString(byte[] b,
              int offset,
              int length,
              String charset)

isBlank

public static boolean isBlank(String str)

Test if a string is null or only has whitespace characters in it.

Note: uses codepoint version of Character.isWhitespace(int) to support Unicode better.

   isBlank(null)   == true
   isBlank("")     == true
   isBlank("\r\n") == true
   isBlank("\t")   == true
   isBlank("   ")  == true
   isBlank("a")    == false
   isBlank(".")    == false
   isBlank(";\n")  == false
 

Parameters:

str - the string to test.

Returns:

true if string is null or only whitespace characters, false if non-whitespace characters encountered.

isNotBlank

public static boolean isNotBlank(String str)

Test if a string is not null and contains at least 1 non-whitespace characters in it.

Note: uses codepoint version of Character.isWhitespace(int) to support Unicode better.

   isNotBlank(null)   == false
   isNotBlank("")     == false
   isNotBlank("\r\n") == false
   isNotBlank("\t")   == false
   isNotBlank("   ")  == false
   isNotBlank("a")    == true
   isNotBlank(".")    == true
   isNotBlank(";\n")  == true
 

Parameters:

str - the string to test.

Returns:

true if string is not null and has at least 1 non-whitespace character, false if null or all-whitespace characters.

isUTF8

public static boolean isUTF8(String charset)

printable

public static String printable(String name)

printable

public static String printable(byte[] b)

getBytes

public static byte[] getBytes(String s)

getUtf8Bytes

public static byte[] getUtf8Bytes(String s)

getBytes

public static byte[] getBytes(String s,
              String charset)

sidBytesToString

public static String sidBytesToString(byte[] sidBytes)

Converts a binary SID to a string SID http://en.wikipedia.org/wiki/Security_Identifier S-1-IdentifierAuthority-SubAuthority1-SubAuthority2-...-SubAuthorityn

sidStringToBytes

public static byte[] sidStringToBytes(String sidString)

Converts a string SID to a binary SID http://en.wikipedia.org/wiki/Security_Identifier S-1-IdentifierAuthority-SubAuthority1-SubAuthority2-...-SubAuthorityn

toInt

public static int toInt(String string)

Convert String to an integer. Parses up to the first non-numeric character. If no number is found an IllegalArgumentException is thrown

Parameters:

string - A String containing an integer.

Returns:

an int

toLong

public static long toLong(String string)

Convert String to an long. Parses up to the first non-numeric character. If no number is found an IllegalArgumentException is thrown

Parameters:

string - A String containing an integer.

Returns:

an int

truncate

public static String truncate(String str,
              int maxSize)

Truncate a string to a max size.

Parameters:

str - the string to possibly truncate

maxSize - the maximum size of the string

Returns:

the truncated string. if str param is null, then the returned string will also be null.

arrayFromString

public static String[] arrayFromString(String s)