StringUtils (Apache Tomcat 9.0.117 API Documentation)
Description: declaration: package: org.apache.tomcat.util.codec.binary, class: StringUtils

# Class StringUtils

java.lang.Object
org.apache.tomcat.util.codec.binary.StringUtils

@Deprecated public class StringUtils extends Object
Deprecated.
Unused. This class will be removed in Tomcat 11 onwards.
Converts String to and from bytes using the encodings required by the Java specification. These encodings are specified in Standard charsets.

This class is immutable and thread-safe.

Since:
  1.4
See Also:
  - `Charset`
  - `StandardCharsets`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static byte[]`
  `getBytesUtf8(String string)`
  Deprecated.
  Encodes the given string into a sequence of bytes using the UTF-8 charset, storing the result into a new byte array.
  `static String`
  `newStringUsAscii(byte[] bytes)`
  Deprecated.
  Constructs a new `String` by decoding the specified array of bytes using the US-ASCII charset.
  `static String`
  `newStringUtf8(byte[] bytes)`
  Deprecated.
  Constructs a new `String` by decoding the specified array of bytes using the UTF-8 charset.

  ### Methods inherited from class Object

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

- ## Method Details

  - ### getBytesUtf8

    public static byte[] getBytesUtf8(String string)
    Deprecated.
    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, may be `null`
    Returns:
      encoded bytes, or `null` if the input string was `null`
    Throws:
      `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:
      - `Charset`

  - ### newStringUsAscii

    public static String newStringUsAscii(byte[] bytes)
    Deprecated.
    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 US-ASCII charset, or `null` if the input byte array was `null`.
    Throws:
      `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

    public static String newStringUtf8(byte[] bytes)
    Deprecated.
    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 UTF-8 charset, or `null` if the input byte array was `null`.
    Throws:
      `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