com.phloc.commons.codec

Interface ICodec

All Superinterfaces:

IByteArrayDecoder, IByteArrayEncoder, IDecoder<byte[]>, IEncoder<byte[]>

All Known Subinterfaces:

IStringCodec

All Known Implementing Classes:

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

public interface ICodec
extends IByteArrayEncoder, IByteArrayDecoder

Interface for a single encoder + decoder.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	decode(String sEncoded, Charset aCharset) Decode the passed string.
byte[]	encode(String sDecoded, Charset aCharset) Encode the passed string.

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

encode

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

decode

Method Detail

encode

@Nullable
byte[] encode(@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:

EncoderException - In case something goes wrong

decode

@Nullable
byte[] decode(@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:

DecoderException - in case something goes wrong