Package com.nimbusds.jose.util

Class Base64

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    Base64URL
    @Immutable
public class Base64
extends java.lang.Object
implements java.io.Serializable
    Base64-encoded object.
    Version:
    2019-10-04
    Author:
    Vladimir Dzhuvinov
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      Base64​(java.lang.String base64)
      Creates a new Base64-encoded object.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte[] decode()
      Decodes this Base64 object to a byte array.
      java.math.BigInteger decodeToBigInteger()
      Decodes this Base64 object to an unsigned big integer.
      java.lang.String decodeToString()
      Decodes this Base64 object to a string.
      static Base64 encode​(byte[] bytes)
      Base64-encodes the specified byte array.
      static Base64 encode​(java.lang.String text)
      Base64-encodes the specified string.
      static Base64 encode​(java.math.BigInteger bigInt)
      Base64-encodes the specified big integer, without the sign bit.
      boolean equals​(java.lang.Object object)
      Overrides Object.equals().
      static Base64 from​(java.lang.String base64)
      Creates a new Base64-encoded object from the specified string.
      int hashCode()
      Overrides Object.hashCode().
      java.lang.String toJSONString()
      Returns a JSON string representation of this object.
      java.lang.String toString()
      Returns a Base64 string representation of this object.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Base64

        public Base64​(java.lang.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 Detail

      • decode

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

      • decodeToBigInteger

        public java.math.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 java.lang.String decodeToString()
        Decodes this Base64 object to a string.
        Returns:
        The resulting string, in the UTF-8 character set.

      • toJSONString

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

      • toString

        public java.lang.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 java.lang.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 java.lang.Object
        Returns:
        The object hash code.

      • equals

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

      • from

        public static Base64 from​(java.lang.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​(java.math.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​(java.lang.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.