org.apache.commons.codec.binary

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.

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.

Since:

1.15

See Also:

RFC 4648 - 8. Base 16 Encoding

Field Summary

Fields inherited from class org.apache.commons.codec.binary.BaseNCodec

DECODING_POLICY_DEFAULT, lineLength, MASK_8BITS, MIME_CHUNK_SIZE, pad, PAD, PAD_DEFAULT, PEM_CHUNK_SIZE

Constructor Summary

Constructors

Constructor and Description
Base16() Creates a Base16 codec used for decoding and encoding.
Base16(boolean lowerCase) Creates a Base16 codec used for decoding and encoding.
Base16(boolean lowerCase, CodecPolicy decodingPolicy) Creates a Base16 codec used for decoding and encoding.

Method Summary

Modifier and Type	Method and Description
boolean	isInAlphabet(byte octet) Returns whether or not the octet is in the Base16 alphabet.

Methods inherited from class org.apache.commons.codec.binary.BaseNCodec

containsAlphabetOrPad, decode, decode, decode, encode, encode, encode, encodeAsString, encodeToString, ensureBufferSize, getChunkSeparator, getCodecPolicy, getDefaultBufferSize, getEncodedLength, isInAlphabet, isInAlphabet, isStrictDecoding, isWhiteSpace

Methods inherited from class java.lang.Object

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

Constructor Detail

Base16

public Base16()

Creates a Base16 codec used for decoding and encoding.

Base16

public Base16(boolean lowerCase)

Creates a Base16 codec used for decoding and encoding.

Parameters:

lowerCase - if true then use a lower-case Base16 alphabet.

Base16

public Base16(boolean lowerCase,
              CodecPolicy decodingPolicy)

Creates a Base16 codec used for decoding and encoding.

Parameters:

lowerCase - if true then use a lower-case Base16 alphabet.

decodingPolicy - Decoding policy.

Method Detail

isInAlphabet

public boolean isInAlphabet(byte octet)

Returns whether or not 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 the Base16 alphabet false otherwise.