public class

StringUtils

extends Object
java.lang.Object
   ↳ org.apache.commons.codec.binary.StringUtils

Class Overview

Converts String to and from bytes using the encodings required by the Java specification. These encodings are specified in Standard charsets

See Also

Summary

Public Constructors
StringUtils()
Public Methods
static byte[] getBytesIso8859_1(String string)
Encodes the given string into a sequence of bytes using the ISO-8859-1 charset, storing the result into a new byte array.
static byte[] getBytesUnchecked(String string, String charsetName)
Encodes the given string into a sequence of bytes using the named charset, storing the result into a new byte array.
static byte[] getBytesUsAscii(String string)
Encodes the given string into a sequence of bytes using the US-ASCII charset, storing the result into a new byte array.
static byte[] getBytesUtf16(String string)
Encodes the given string into a sequence of bytes using the UTF-16 charset, storing the result into a new byte array.
static byte[] getBytesUtf16Be(String string)
Encodes the given string into a sequence of bytes using the UTF-16BE charset, storing the result into a new byte array.
static byte[] getBytesUtf16Le(String string)
Encodes the given string into a sequence of bytes using the UTF-16LE charset, storing the result into a new byte array.
static byte[] getBytesUtf8(String string)
Encodes the given string into a sequence of bytes using the UTF-8 charset, storing the result into a new byte array.
static String newString(byte[] bytes, String charsetName)
Constructs a new String by decoding the specified array of bytes using the given charset.
static String newStringIso8859_1(byte[] bytes)
Constructs a new String by decoding the specified array of bytes using the ISO-8859-1 charset.
static String newStringUsAscii(byte[] bytes)
Constructs a new String by decoding the specified array of bytes using the US-ASCII charset.
static String newStringUtf16(byte[] bytes)
Constructs a new String by decoding the specified array of bytes using the UTF-16 charset.
static String newStringUtf16Be(byte[] bytes)
Constructs a new String by decoding the specified array of bytes using the UTF-16BE charset.
static String newStringUtf16Le(byte[] bytes)
Constructs a new String by decoding the specified array of bytes using the UTF-16LE charset.
static String newStringUtf8(byte[] bytes)
Constructs a new String by decoding the specified array of bytes using the UTF-8 charset.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public StringUtils ()

Public Methods

public static byte[] getBytesIso8859_1 (String string)

Encodes the given string into a sequence of bytes using the ISO-8859-1 charset, storing the result into a new byte array.

Parameters
string the String to encode
Returns
  • encoded bytes
Throws
IllegalStateException Thrown when the charset is missing, which should be never according the the Java specification.
See Also

public static byte[] getBytesUnchecked (String string, String charsetName)

Encodes the given string into a sequence of bytes using the named charset, storing the result into a new byte array.

This method catches UnsupportedEncodingException and rethrows it as IllegalStateException, which should never happen for a required charset name. Use this method when the encoding is required to be in the JRE.

Parameters
string the String to encode
charsetName The name of a required java.nio.charset.Charset
Returns
  • encoded bytes
Throws
IllegalStateException Thrown when a UnsupportedEncodingException is caught, which should never happen for a required charset name.
See Also

public static byte[] getBytesUsAscii (String string)

Encodes the given string into a sequence of bytes using the US-ASCII charset, storing the result into a new byte array.

Parameters
string the String to encode
Returns
  • encoded bytes
Throws
IllegalStateException Thrown when the charset is missing, which should be never according the the Java specification.
See Also

public static byte[] getBytesUtf16 (String string)

Encodes the given string into a sequence of bytes using the UTF-16 charset, storing the result into a new byte array.

Parameters
string the String to encode
Returns
  • encoded bytes
Throws
IllegalStateException Thrown when the charset is missing, which should be never according the the Java specification.
See Also

public static byte[] getBytesUtf16Be (String string)

Encodes the given string into a sequence of bytes using the UTF-16BE charset, storing the result into a new byte array.

Parameters
string the String to encode
Returns
  • encoded bytes
Throws
IllegalStateException Thrown when the charset is missing, which should be never according the the Java specification.
See Also

public static byte[] getBytesUtf16Le (String string)

Encodes the given string into a sequence of bytes using the UTF-16LE charset, storing the result into a new byte array.

Parameters
string the String to encode
Returns
  • encoded bytes
Throws
IllegalStateException Thrown when the charset is missing, which should be never according the the Java specification.
See Also

public static byte[] getBytesUtf8 (String string)

Encodes the given string into a sequence of bytes using the UTF-8 charset, storing the result into a new byte array.

Parameters
string the String to encode
Returns
  • encoded bytes
Throws
IllegalStateException Thrown when the charset is missing, which should be never according the the Java specification.
See Also

public static String newString (byte[] bytes, String charsetName)

Constructs a new String by decoding the specified array of bytes using the given charset.

This method catches UnsupportedEncodingException and re-throws it as IllegalStateException, which should never happen for a required charset name. Use this method when the encoding is required to be in the JRE.

Parameters
bytes The bytes to be decoded into characters
charsetName The name of a required java.nio.charset.Charset
Returns
  • A new String decoded from the specified array of bytes using the given charset.
Throws
IllegalStateException Thrown when a UnsupportedEncodingException is caught, which should never happen for a required charset name.
See Also

public static String newStringIso8859_1 (byte[] bytes)

Constructs a new String by decoding the specified array of bytes using the ISO-8859-1 charset.

Parameters
bytes The bytes to be decoded into characters
Returns
  • A new String decoded from the specified array of bytes using the given charset.
Throws
IllegalStateException Thrown when a UnsupportedEncodingException is caught, which should never happen since the charset is required.

public static String newStringUsAscii (byte[] bytes)

Constructs a new String by decoding the specified array of bytes using the US-ASCII charset.

Parameters
bytes The bytes to be decoded into characters
Returns
  • A new String decoded from the specified array of bytes using the given charset.
Throws
IllegalStateException Thrown when a UnsupportedEncodingException is caught, which should never happen since the charset is required.

public static String newStringUtf16 (byte[] bytes)

Constructs a new String by decoding the specified array of bytes using the UTF-16 charset.

Parameters
bytes The bytes to be decoded into characters
Returns
  • A new String decoded from the specified array of bytes using the given charset.
Throws
IllegalStateException Thrown when a UnsupportedEncodingException is caught, which should never happen since the charset is required.

public static String newStringUtf16Be (byte[] bytes)

Constructs a new String by decoding the specified array of bytes using the UTF-16BE charset.

Parameters
bytes The bytes to be decoded into characters
Returns
  • A new String decoded from the specified array of bytes using the given charset.
Throws
IllegalStateException Thrown when a UnsupportedEncodingException is caught, which should never happen since the charset is required.

public static String newStringUtf16Le (byte[] bytes)

Constructs a new String by decoding the specified array of bytes using the UTF-16LE charset.

Parameters
bytes The bytes to be decoded into characters
Returns
  • A new String decoded from the specified array of bytes using the given charset.
Throws
IllegalStateException Thrown when a UnsupportedEncodingException is caught, which should never happen since the charset is required.

public static String newStringUtf8 (byte[] bytes)

Constructs a new String by decoding the specified array of bytes using the UTF-8 charset.

Parameters
bytes The bytes to be decoded into characters
Returns
  • A new String decoded from the specified array of bytes using the given charset.
Throws
IllegalStateException Thrown when a UnsupportedEncodingException is caught, which should never happen since the charset is required.