Package com.helger.commons.codec

Class URLCodec

java.lang.Object

com.helger.commons.codec.URLCodec

All Implemented Interfaces:

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

@ThreadSafe
public class URLCodec
extends Object
implements IByteArrayCodec

Encoder and decoder for URL stuff based on RFC 3986.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
URLCodec()	Default constructor with the RFC 3986 printable characters.
URLCodec(BitSet aPrintableChars)	Constructor with an arbitrary set of printable characters.

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	writeEncodedURLByte(int b, OutputStream aOS)	Encodes byte into its URL 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

URLCodec

public URLCodec()

Default constructor with the RFC 3986 printable characters.

URLCodec

public URLCodec(@Nonnull
                BitSet aPrintableChars)

Constructor with an arbitrary set of printable characters.

Parameters:

aPrintableChars - The printable character BitSet to use. May not be null.

Method Detail

getDefaultPrintableChars

@Nonnull
@ReturnsMutableCopy
public static BitSet getDefaultPrintableChars()

Returns:

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

getPrintableChars

@Nonnull
@ReturnsMutableCopy
public BitSet getPrintableChars()

Returns:

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

writeEncodedURLByte

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

Encodes byte into its URL representation.

Parameters:

b - byte to encode

aOS - the output stream to write to. May not be null.

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!