Class Base16

java.lang.Object
org.apache.commons.codec.binary.BaseNCodec
org.apache.commons.codec.binary.Base16
All Implemented Interfaces:
BinaryDecoder, BinaryEncoder, Decoder, Encoder

public class Base16 extends BaseNCodec
Provides Base16 encoding and decoding as defined by RFC 4648 - 8. Base 16 Encoding.

This class is thread-safe.

This implementation strictly follows RFC 4648, and as such unlike the Base32 and Base64 implementations, it does not ignore invalid alphabet characters or whitespace, neither does it offer chunking or padding characters.

The only additional feature above those specified in RFC 4648 is support for working with a lower-case alphabet in addition to the default upper-case alphabet, and configuring a custom 16-byte alphabet with Base16.Builder.setEncodeTable(byte...).

Since:
1.15
See Also:
  • Field Details

    • BITS_PER_ENCODED_BYTE

      private static final int BITS_PER_ENCODED_BYTE
      BASE16 characters are 4 bits in length. They are formed by taking an 8-bit group, which is converted into two BASE16 characters.
      See Also:
    • BYTES_PER_ENCODED_BLOCK

      private static final int BYTES_PER_ENCODED_BLOCK
      See Also:
    • BYTES_PER_UNENCODED_BLOCK

      private static final int BYTES_PER_UNENCODED_BLOCK
      See Also:
    • UPPER_CASE_DECODE_TABLE

      private static final byte[] UPPER_CASE_DECODE_TABLE
      This array is a lookup table that translates Unicode characters drawn from the "Base16 Alphabet" (as specified in Table 5 of RFC 4648) into their 4-bit positive integer equivalents. Characters that are not in the Base16 alphabet but fall within the bounds of the array are translated to -1.
    • UPPER_CASE_ENCODE_TABLE

      private static final byte[] UPPER_CASE_ENCODE_TABLE
      This array is a lookup table that translates 4-bit positive integer index values into their "Base16 Alphabet" equivalents as specified in Table 5 of RFC 4648.
    • LOWER_CASE_DECODE_TABLE

      private static final byte[] LOWER_CASE_DECODE_TABLE
      This array is a lookup table that translates Unicode characters drawn from the a lower-case "Base16 Alphabet" into their 4-bit positive integer equivalents. Characters that are not in the Base16 alphabet but fall within the bounds of the array are translated to -1.
    • LOWER_CASE_ENCODE_TABLE

      private static final byte[] LOWER_CASE_ENCODE_TABLE
      This array is a lookup table that translates 4-bit positive integer index values into their "Base16 Alphabet" lower-case equivalents.
    • MASK_4_BITS

      private static final int MASK_4_BITS
      Mask used to extract 4 bits, used when decoding character.
      See Also:
  • Constructor Details

    • Base16

      public Base16()
      Constructs a Base16 codec used for decoding and encoding.
    • Base16

      @Deprecated public Base16(boolean lowerCase)
      Deprecated.
      Constructs a Base16 codec used for decoding and encoding.
      Parameters:
      lowerCase - true to use the lower-case Base16 alphabet.
    • Base16

      @Deprecated public Base16(boolean lowerCase, CodecPolicy decodingPolicy)
      Deprecated.
      Constructs a Base16 codec used for decoding and encoding.
      Parameters:
      lowerCase - true to use the lower-case Base16 alphabet.
      decodingPolicy - Decoding policy.
    • Base16

      private Base16(Base16.Builder builder)
  • Method Details

    • builder

      public static Base16.Builder builder()
      Constructs a new builder.
      Returns:
      A new builder.
      Since:
      1.20.0
    • toDecodeTable

      private static byte[] toDecodeTable(byte[] encodeTable)
    • decode

      void decode(byte[] data, int offset, int length, BaseNCodec.Context context)
      Decodes a byte[] containing characters in the Base-N alphabet into a temporary context buffer.

      This method is package protected for access from I/O streams.

      Specified by:
      decode in class BaseNCodec
      Parameters:
      data - A byte array containing Base-N character data.
      offset - initial offset of the subarray.
      length - length of the subarray.
      Throws:
      IllegalArgumentException - Thrown when a problem is detected processing data.
    • decodeOctet

      private int decodeOctet(byte octet)
    • encode

      void encode(byte[] data, int offset, int length, BaseNCodec.Context context)
      Description copied from class: BaseNCodec
      Encodes a byte[] containing characters in the Base-N alphabet into a temporary context buffer.

      This method is package protected for access from I/O streams.

      Specified by:
      encode in class BaseNCodec
      Parameters:
      data - A byte array containing Base-N character data.
      offset - initial offset of the subarray.
      length - length of the subarray.
    • isInAlphabet

      public boolean isInAlphabet(byte octet)
      Tests whether the octet is in the Base16 alphabet.
      Specified by:
      isInAlphabet in class BaseNCodec
      Parameters:
      octet - The value to test.
      Returns:
      true if the value is defined in the Base16 alphabet false otherwise.
    • validateTrailingCharacter

      private void validateTrailingCharacter()
      Validates whether decoding allows an entire final trailing character that cannot be used for a complete byte.
      Throws:
      IllegalArgumentException - Thrown if strict decoding is enabled.