Tomcat 10.1.19 · org.apache.tomcat.util.codec.binary.StringUtils

Access	Constructor and Description
public	StringUtils()

Method Summary

Modifier and Type	Method and Description
private static byte[]	Returns: the encoded bytes getBytes(final String The string to encode (if null, return null). string, final Charset The `Charset` to encode the `String` charset) Calls `String#getBytes(Charset)`
public static byte[]	Returns: encoded bytes, or `null` if the input string was `null` getBytesUtf8(final String the String to encode, may be `null` string) Encodes the given string into a sequence of bytes using the UTF-8 charset, storing the result into a new byte array.
private static String	Returns: A new `String` decoded from the specified array of bytes using the given charset, or `null` if the input byte array was `null`. newString(final byte[] The bytes to be decoded into characters bytes, final Charset The `Charset` to encode the `String`; not `null` charset) Constructs a new `String` by decoding the specified array of bytes using the given charset.
public static String	Returns: A new `String` decoded from the specified array of bytes using the US-ASCII charset, or `null` if the input byte array was `null`. newStringUsAscii(final byte[] The bytes to be decoded into characters bytes) Constructs a new `String` by decoding the specified array of bytes using the US-ASCII charset.
public static String	Returns: A new `String` decoded from the specified array of bytes using the UTF-8 charset, or `null` if the input byte array was `null`. newStringUtf8(final byte[] The bytes to be decoded into characters bytes) Constructs a new `String` by decoding the specified array of bytes using the UTF-8 charset.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

StringUtils	back to summary
public StringUtils()

Method Detail

getBytes back to summary

getBytes	back to summary
private static byte[] getBytes(final String string, final Charset charset) Calls `String#getBytes(Charset)` Parameters string:String The string to encode (if null, return null). charset:Charset The `Charset` to encode the `String` Returns:byte[] the encoded bytes

private static byte[] getBytes(final String string, final Charset charset)

Calls String#getBytes(Charset)

Parameters

string:String: The string to encode (if null, return null).
charset:Charset: The Charset to encode the String

Returns:byte[]

the encoded bytes

getBytesUtf8 back to summary

getBytesUtf8	back to summary
public static byte[] getBytesUtf8(final 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:String the String to encode, may be `null` Returns:byte[] encoded bytes, or `null` if the input string was `null` Exceptions NullPointerException: Thrown if `StandardCharsets#UTF_8` is not initialized, which should never happen since it is required by the Java platform specification. Since As of 1.7, throws `NullPointerException` instead of UnsupportedEncodingException See Also Standard charsets

public static byte[] getBytesUtf8(final 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:String: the String to encode, may be null

Returns:byte[]

encoded bytes, or null if the input string was null

Exceptions

NullPointerException:: Thrown if StandardCharsets#UTF_8 is not initialized, which should never happen since it is required by the Java platform specification.

Since

As of 1.7, throws NullPointerException instead of UnsupportedEncodingException

See Also

Standard charsets

newString back to summary

newString	back to summary
private static String newString(final byte[] bytes, final Charset charset) Constructs a new `String` by decoding the specified array of bytes using the given charset. Parameters bytes:byte[] The bytes to be decoded into characters charset:Charset The `Charset` to encode the `String`; not `null` Returns:String A new `String` decoded from the specified array of bytes using the given charset, or `null` if the input byte array was `null`. Exceptions NullPointerException: Thrown if charset is `null`

private static String newString(final byte[] bytes, final Charset charset)

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

Parameters

bytes:byte[]: The bytes to be decoded into characters
charset:Charset: The Charset to encode the String; not null

Returns:String

A new String decoded from the specified array of bytes using the given charset, or null if the input byte array was null.

Exceptions

NullPointerException:: Thrown if charset is null

newStringUsAscii back to summary

newStringUsAscii	back to summary
public static String newStringUsAscii(final byte[] bytes) Constructs a new `String` by decoding the specified array of bytes using the US-ASCII charset. Parameters bytes:byte[] The bytes to be decoded into characters Returns:String A new `String` decoded from the specified array of bytes using the US-ASCII charset, or `null` if the input byte array was `null`. Exceptions NullPointerException: Thrown if `StandardCharsets#US_ASCII` is not initialized, which should never happen since it is required by the Java platform specification. Since As of 1.7, throws `NullPointerException` instead of UnsupportedEncodingException

public static String newStringUsAscii(final byte[] bytes)

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

Parameters

bytes:byte[]: The bytes to be decoded into characters

Returns:String

A new String decoded from the specified array of bytes using the US-ASCII charset, or null if the input byte array was null.

Exceptions

NullPointerException:: Thrown if StandardCharsets#US_ASCII is not initialized, which should never happen since it is required by the Java platform specification.

Since

As of 1.7, throws NullPointerException instead of UnsupportedEncodingException

newStringUtf8 back to summary

newStringUtf8	back to summary
public static String newStringUtf8(final byte[] bytes) Constructs a new `String` by decoding the specified array of bytes using the UTF-8 charset. Parameters bytes:byte[] The bytes to be decoded into characters Returns:String A new `String` decoded from the specified array of bytes using the UTF-8 charset, or `null` if the input byte array was `null`. Exceptions NullPointerException: Thrown if `StandardCharsets#UTF_8` is not initialized, which should never happen since it is required by the Java platform specification. Since As of 1.7, throws `NullPointerException` instead of UnsupportedEncodingException

public static String newStringUtf8(final byte[] bytes)

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

Parameters

bytes:byte[]: The bytes to be decoded into characters

Returns:String

A new String decoded from the specified array of bytes using the UTF-8 charset, or null if the input byte array was null.

Exceptions

NullPointerException:: Thrown if StandardCharsets#UTF_8 is not initialized, which should never happen since it is required by the Java platform specification.

Since

As of 1.7, throws NullPointerException instead of UnsupportedEncodingException

public Class StringUtils

Constructor Summary

Method Summary

Constructor Detail

Method Detail