Package com.helger.commons.codec

Class QuotedPrintableCodec

java.lang.Object

com.helger.commons.codec.QuotedPrintableCodec

All Implemented Interfaces:

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

@NotThreadSafe
public class QuotedPrintableCodec
extends Object
implements IByteArrayCodec

Encoder and decoder for quoted printable stuff. Uses "=" as the escape char.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
QuotedPrintableCodec()	Default constructor with the UTF-8 charset.
QuotedPrintableCodec(BitSet aPrintableChars)

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.
static BitSet	getDefaultPrintableChars()
BitSet	getPrintableChars()
static void	writeEncodeQuotedPrintableByte(int b, OutputStream aOS)	Encodes byte into its quoted-printable representation.

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

Constructor Detail

QuotedPrintableCodec

public QuotedPrintableCodec()

Default constructor with the UTF-8 charset.

QuotedPrintableCodec

public QuotedPrintableCodec(@Nonnull
                            BitSet aPrintableChars)

Method Detail

getDefaultPrintableChars

@Nonnull
@ReturnsMutableCopy
public static BitSet getDefaultPrintableChars()

Returns:

A copy of the default bit set to be used.

getPrintableChars

@Nonnull
@ReturnsMutableCopy
public BitSet getPrintableChars()

Returns:

A copy of the default bit set to be used. Never null.

writeEncodeQuotedPrintableByte

public static final void writeEncodeQuotedPrintableByte(int b,
                                                        @Nonnull
                                                        OutputStream aOS)
                                                 throws IOException

Encodes byte into its quoted-printable representation. It will always be 3 characters.

Parameters:

b - byte to encode

aOS - the output stream to write to

Throws:

IOException - In case writing to the OutputStream failed

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!

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!