Package com.helger.commons.codec

Interface IByteArrayStreamEncoder

All Superinterfaces:

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

All Known Subinterfaces:

IByteArrayCodec

All Known Implementing Classes:

Base16Codec, Base32Codec, Base64Codec, FlateCodec, GZIPCodec, IdentityByteArrayCodec, LZWCodec, QuotedPrintableCodec, URLCodec

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 IByteArrayStreamEncoder
extends IByteArrayEncoder

Interface for a single encoder of bytes, based on streams.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
void	encode(byte[] aDecodedBuffer, int nOfs, int nLen, OutputStream aOS)	Encode (part of) a byte array to an OutputStream.
default void	encode(byte[] aDecodedBuffer, OutputStream aOS)	Encode a byte array to an OutputStream.
default byte[]	getEncoded(byte[] aDecodedBuffer)	Encode a byte array.
default byte[]	getEncoded(byte[] aDecodedBuffer, int nOfs, int nLen)	Encode a byte array.
default byte[]	getEncoded(String sDecoded, Charset aCharset)	Encode the passed string.
default String	getEncodedAsString(byte[] aDecodedBuf, int nOfs, int nLen, Charset aCharset)
default String	getEncodedAsString(byte[] aDecodedBuf, Charset aCharset)
default String	getEncodedAsString(String sDecoded, Charset aCharset)	Encode the passed string and return the result as a String.
default int	getMaximumEncodedLength(int nDecodedLen)	Get the maximum encoded length based on the provided decoded length.

Method Detail

getMaximumEncodedLength

@Nonnegative
default int getMaximumEncodedLength(@Nonnegative
                                    int nDecodedLen)

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

Parameters:

nDecodedLen - The decoded length. Always ≥ 0.

Returns:

The maximum encoded length. Always ≥ 0.

encode

default void encode(@Nullable
                    byte[] aDecodedBuffer,
                    @Nonnull @WillNotClose
                    OutputStream aOS)

Encode a byte array to an OutputStream.

Parameters:

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

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

Throws:

EncodeException - In case something goes wrong

Since:

9.0.0

encode

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

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

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!

Throws:

EncodeException - In case something goes wrong

getEncoded

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

Encode a byte array.

Specified by:

getEncoded in interface IByteArrayEncoder

Specified by:

getEncoded in interface IEncoder<byte[],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
default byte[] getEncoded(@Nullable
                          byte[] aDecodedBuffer,
                          @Nonnegative
                          int nOfs,
                          @Nonnegative
                          int nLen)

Encode a byte array.

Specified by:

getEncoded in interface IByteArrayEncoder

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.

Returns:

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

Throws:

EncodeException - In case something goes wrong

getEncoded

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

Encode the passed string.

Specified by:

getEncoded in interface IByteArrayEncoder

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

getEncodedAsString

@Nullable
default String getEncodedAsString(@Nullable
                                  byte[] aDecodedBuf,
                                  @Nonnull
                                  Charset aCharset)

getEncodedAsString

@Nullable
default String getEncodedAsString(@Nullable
                                  byte[] aDecodedBuf,
                                  @Nonnegative
                                  int nOfs,
                                  @Nonnegative
                                  int nLen,
                                  @Nonnull
                                  Charset aCharset)

getEncodedAsString

@Nullable
default String getEncodedAsString(@Nullable
                                  String sDecoded,
                                  @Nonnull
                                  Charset aCharset)

Encode the passed string and return the result as a 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