com.helger.commons.codec

Interface IEncoder<SRCTYPE,DSTTYPE>

Type Parameters:

SRCTYPE - Source data type

DSTTYPE - Destination data type

All Known Subinterfaces:

IByteArrayCodec, IByteArrayEncoder, IByteArrayStreamEncoder, ICharArrayCodec, ICharArrayEncoder, ICharArrayStreamEncoder, ICodec<DATATYPE>

All Known Implementing Classes:

AbstractRFC1522Codec, Base16Codec, Base32Codec, Base64Codec, FlateCodec, GZIPCodec, IdentityByteArrayCodec, IdentityCodec, LZWCodec, QuotedPrintableCodec, RFC1522BCodec, RFC1522QCodec, RFC2616Codec, URLCodec, URLParameterEncoder

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface IEncoder<SRCTYPE,DSTTYPE>

The most basic encoding interface

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
DSTTYPE	getEncoded(SRCTYPE aInput) Encode the passed source object

Method Detail

getEncoded

@Nullable
DSTTYPE getEncoded(@Nullable
                              SRCTYPE aInput)

Encode the passed source object

Parameters:

aInput - The source object to be encoded

Returns:

The encoded value.

Throws:

EncodeException - In case something goes wrong