Package com.nimbusds.jose.util

Class Base64

java.lang.Object
com.nimbusds.jose.util.Base64
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
Base64URL
@Immutable public class Base64 extends Object implements Serializable
Base64-encoded object.
Version:
2024-04-20
Author:
Vladimir Dzhuvinov
See Also:

  • Constructor Details

    • Base64

      public Base64(String base64)
      Creates a new Base64-encoded object.
      Parameters:
      base64 - The Base64-encoded object value. The value is not validated for having characters from a Base64 alphabet. Must not be null.

  • Method Details

    • decode

      public byte[] decode()
      Decodes this Base64 object to a byte array.
      Returns:
      The resulting byte array.

    • decodeToBigInteger

      public BigInteger decodeToBigInteger()
      Decodes this Base64 object to an unsigned big integer.

      Same as new BigInteger(1, base64.decode()).

      Returns:
      The resulting big integer.

    • decodeToString

      public String decodeToString()
      Decodes this Base64 object to a string.
      Returns:
      The resulting string, in the UTF-8 character set.

    • toJSONString

      public String toJSONString()
      Returns a JSON string representation of this object.
      Returns:
      The JSON string representation of this object.

    • toString

      public String toString()
      Returns a Base64 string representation of this object. The string will be chunked into 76 character blocks separated by CRLF.
      Overrides:
      toString in class Object
      Returns:
      The Base64 string representation, chunked into 76 character blocks separated by CRLF.

    • hashCode

      public int hashCode()
      Overrides Object.hashCode().
      Overrides:
      hashCode in class Object
      Returns:
      The object hash code.

    • equals

      public boolean equals(Object object)
      Overrides Object.equals().
      Overrides:
      equals in class Object
      Parameters:
      object - The object to compare to.
      Returns:
      true if the objects have the same value, otherwise false.

    • from

      public static Base64 from(String base64)
      Creates a new Base64-encoded object from the specified string.
      Parameters:
      base64 - The Base64-encoded object value, null if not specified. The value is not validated for having characters from the Base64 alphabet.
      Returns:
      The Base64-encoded object, null if not specified.

    • encode

      public static Base64 encode(byte[] bytes)
      Base64-encodes the specified byte array.
      Parameters:
      bytes - The byte array to encode. Must not be null.
      Returns:
      The resulting Base64 object.

    • encode

      public static Base64 encode(BigInteger bigInt)
      Base64-encodes the specified big integer, without the sign bit.
      Parameters:
      bigInt - The big integer to encode. Must not be null.
      Returns:
      The resulting Base64 object.

    • encode

      public static Base64 encode(String text)
      Base64-encodes the specified string.
      Parameters:
      text - The string to encode. Must be in the UTF-8 character set and not null.
      Returns:
      The resulting Base64 object.