Package com.helger.commons.codec

Class Base32Codec

java.lang.Object

com.helger.commons.codec.Base32Codec

All Implemented Interfaces:

IByteArrayCodec, IByteArrayDecoder, IByteArrayEncoder, IByteArrayStreamDecoder, IByteArrayStreamEncoder, ICodec<byte[]>, IDecoder<byte[],byte[]>, IEncoder<byte[],byte[]>, Serializable

public class Base32Codec
extends Object
implements IByteArrayCodec

Base32 encoder and decoder based on Apache Commons Codec Base32. Defined in RFC 4648. BASE32 characters are 5 bits in length. They are formed by taking a block of five octets to form a 40-bit string, which is converted into eight BASE32 characters.
RFC 3548 and defines only the "regular encoding". RFC 4648 adds the "hex encoding". So when using the "regular encoding" it is compliant to both RFCs.
Source: https://tools.ietf.org/html/rfc4648
Source: https://tools.ietf.org/html/rfc3548

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Base32Codec()	Creates a Base32 codec used for decoding and encoding.
Base32Codec(boolean bUseHex)	Creates a Base32 codec used for decoding and encoding.

Method Summary

Modifier and Type	Method	Description
void	decode(byte[] aEncodedBuffer, int nOfs, int nLen, OutputStream aOS)	Decode (part of) a byte array.
void	encode(byte[] aDecodedBuffer, int nOfs, int nLen, OutputStream aOS)	Encode (part of) a byte array to an OutputStream.
int	getMaximumDecodedLength(int nLen)	Get the maximum decoded length based on the provided encoded length.
int	getMaximumEncodedLength(int nLen)	Get the maximum encoded length based on the provided decoded length.
byte	getPad()
boolean	isAddPadding()
boolean	isHexEncoding()
Base32Codec	setAddPaddding(boolean bAddPadding)
Base32Codec	setPad(byte nPad)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.codec.IByteArrayDecoder

getDecoded, getDecoded, getDecodedLength

Methods inherited from interface com.helger.commons.codec.IByteArrayEncoder

getEncodedLength

Methods inherited from interface com.helger.commons.codec.IByteArrayStreamDecoder

decode, getDecoded, getDecodedAsString, getDecodedAsString, getDecodedAsString, getDecodedAsString

Methods inherited from interface com.helger.commons.codec.IByteArrayStreamEncoder

encode, getEncoded, getEncoded, getEncoded, getEncodedAsString, getEncodedAsString, getEncodedAsString

Constructor Detail

Base32Codec

public Base32Codec()

Creates a Base32 codec used for decoding and encoding.

Base32Codec

public Base32Codec(boolean bUseHex)

Creates a Base32 codec used for decoding and encoding.

Parameters:

bUseHex - true to use hex encoding, false to use regular encoding.

Method Detail

isHexEncoding

public boolean isHexEncoding()

getPad

public byte getPad()

setPad

@Nonnull
public Base32Codec setPad(byte nPad)

isAddPadding

public boolean isAddPadding()

setAddPaddding

@Nonnull
public Base32Codec setAddPaddding(boolean bAddPadding)

getMaximumEncodedLength

public int getMaximumEncodedLength(int nLen)

Description copied from interface: IByteArrayEncoder

Get the maximum encoded length based on the provided decoded length. This is purely for performance reasons. The name of the method would be better called "getMaximumEncodedLength".

Specified by:

getMaximumEncodedLength in interface IByteArrayEncoder

Specified by:

getMaximumEncodedLength in interface IByteArrayStreamEncoder

Parameters:

nLen - The decoded length. Always ≥ 0.

Returns:

The maximum encoded length. Always ≥ 0.

encode

public void encode(@Nullable
                   byte[] aDecodedBuffer,
                   @Nonnegative
                   int nOfs,
                   @Nonnegative
                   int nLen,
                   @Nonnull @WillNotClose
                   OutputStream aOS)

Description copied from interface: IByteArrayStreamEncoder

Encode (part of) a byte array to an OutputStream.

Specified by:

encode in interface IByteArrayStreamEncoder

Parameters:

aDecodedBuffer - The byte array to be encoded. May be null.

nOfs - Offset into the byte array to start from.

nLen - Number of bytes starting from offset to consider.

aOS - The output stream to write to. May not be null and is NOT closed afterwards!

getMaximumDecodedLength

public int getMaximumDecodedLength(int nLen)

Description copied from interface: IByteArrayDecoder

Get the maximum decoded length based on the provided encoded length. This is purely for performance reasons.

Specified by:

getMaximumDecodedLength in interface IByteArrayDecoder

Parameters:

nLen - The encoded length. Always ≥ 0.

Returns:

The maximum decoded length. Always ≥ 0.

decode

public void decode(@Nullable
                   byte[] aEncodedBuffer,
                   @Nonnegative
                   int nOfs,
                   @Nonnegative
                   int nLen,
                   @Nonnull @WillNotClose
                   OutputStream aOS)

Description copied from interface: IByteArrayStreamDecoder

Decode (part of) a byte array.

Specified by:

decode in interface IByteArrayStreamDecoder

Parameters:

aEncodedBuffer - The byte array to be decoded. May be null.

nOfs - Offset into the byte array to start from.

nLen - Number of bytes starting from offset to consider.

aOS - The output stream to write to. May not be null and is NOT closed afterwards!