com.helger.commons.codec

Interface IByteArrayDecoder

All Superinterfaces:

IDecoder<byte[]>

All Known Subinterfaces:

IByteArrayCodec

All Known Implementing Classes:

AbstractByteArrayCodec, AbstractByteArrayDecoder, AbstractRFC1522Codec, ASCII85Codec, ASCIIHexCodec, Base64Codec, DCTCodec, FlateCodec, LZWCodec, QuotedPrintableCodec, RFC1522BCodec, RFC1522QCodec, RunLengthCodec, URLCodec

public interface IByteArrayDecoder
extends IDecoder<byte[]>

Interface for a single decoder.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getDecoded(byte[] aEncodedBuffer) Decode a byte array.
byte[]	getDecoded(String sEncoded, Charset aCharset) Decode the passed string.

Method Detail

getDecoded

@Nullable
@ReturnsMutableCopy
byte[] getDecoded(@Nullable
                                            byte[] aEncodedBuffer)

Decode a byte array.

Specified by:

getDecoded in interface IDecoder<byte[]>

Parameters:

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

Returns:

The decoded byte array or null if the parameter was null.

Throws:

DecodeException - in case something goes wrong

getDecoded

@Nullable
@ReturnsMutableCopy
byte[] getDecoded(@Nullable
                                            String sEncoded,
                                            @Nonnull
                                            Charset aCharset)

Decode the passed string.

Parameters:

sEncoded - The string to be decoded. May be null.

aCharset - The charset to be used. May not be null.

Returns:

null if the input string is null.

Throws:

DecodeException - in case something goes wrong