Package com.helger.commons.codec

Class IdentityByteArrayCodec

java.lang.Object

com.helger.commons.codec.IdentityCodec<byte[]>

com.helger.commons.codec.IdentityByteArrayCodec

All Implemented Interfaces:

IByteArrayCodec, IByteArrayDecoder, IByteArrayEncoder, IByteArrayStreamDecoder, IByteArrayStreamEncoder, ICodec<byte[]>, IDecoder<byte[],byte[]>, IEncoder<byte[],byte[]>

public class IdentityByteArrayCodec
extends IdentityCodec<byte[]>
implements IByteArrayCodec

Special implementation of IByteArrayCodec that does nothing. This is a separate class to be able to identify it from non-identity codecs.

Since:

9.1.7

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final IdentityByteArrayCodec	INSTANCE	Default instance that can be used.

Constructor Summary

Constructors

Constructor	Description
IdentityByteArrayCodec()

Method Summary

Modifier and Type	Method	Description
void	decode(byte[] aEncodedBuffer, int nOfs, int nLen, OutputStream aOS)	Decode (part of) a byte array.
void	encode(byte[] aDecodedBuffer, int nOfs, int nLen, OutputStream aOS)	Encode (part of) a byte array to an OutputStream.

Methods inherited from class com.helger.commons.codec.IdentityCodec

getDecoded, getEncoded

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getDecoded, getDecoded, getMaximumDecodedLength

Methods inherited from interface com.helger.commons.codec.IByteArrayStreamDecoder

decode, getDecoded, getDecodedAsString, getDecodedAsString, getDecodedAsString, getDecodedAsString

Methods inherited from interface com.helger.commons.codec.IByteArrayStreamEncoder

encode, getEncoded, getEncoded, getEncoded, getEncodedAsString, getEncodedAsString, getEncodedAsString, getMaximumEncodedLength

Field Details

INSTANCE

public static final IdentityByteArrayCodec INSTANCE

Default instance that can be used.

Constructor Details

IdentityByteArrayCodec

public IdentityByteArrayCodec()

Method Details

decode

public void decode(@Nullable
 byte[] aEncodedBuffer,
 @Nonnegative
 int nOfs,
 @Nonnegative
 int nLen,
 @Nonnull @WillNotClose
 OutputStream aOS)

Description copied from interface: IByteArrayStreamDecoder

Decode (part of) a byte array.

Specified by:

decode in interface IByteArrayStreamDecoder

Parameters:

aEncodedBuffer - The byte array to be decoded. 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!

encode

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

Description copied from interface: IByteArrayStreamEncoder

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

Specified by:

encode in interface IByteArrayStreamEncoder

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!