com.helger.commons.codec

Interface IByteArrayEncoder

All Superinterfaces:

IEncoder<byte[]>

All Known Subinterfaces:

IByteArrayCodec

All Known Implementing Classes:

AbstractByteArrayCodec, AbstractRFC1522Codec, Base64Codec, FlateCodec, LZWCodec, QuotedPrintableCodec, RFC1522BCodec, RFC1522QCodec, URLCodec

public interface IByteArrayEncoder
extends IEncoder<byte[]>

Interface for a single encoder

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
byte[]	getEncoded(byte[] aDecodedBuffer) Encode a byte array.
byte[]	getEncoded(String sDecoded, Charset aCharset) Encode the passed string.

Method Detail

getEncoded

@Nullable
 @ReturnsMutableCopy
byte[] getEncoded(@Nullable
                                                   byte[] aDecodedBuffer)

Encode a byte array.

Specified by:

getEncoded in interface IEncoder<byte[]>

Parameters:

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

Returns:

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

Throws:

EncodeException - In case something goes wrong

getEncoded

@Nullable
 @ReturnsMutableCopy
byte[] getEncoded(@Nullable
                                                   String sDecoded,
                                                   @Nonnull
                                                   Charset aCharset)

Encode the passed string.

Parameters:

sDecoded - The string to be encoded. May be null.

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

Returns:

null if the input string is null.

Throws:

EncodeException - In case something goes wrong