com.helger.commons.codec

Class URLCodec

java.lang.Object

com.helger.commons.codec.AbstractByteArrayDecoder

com.helger.commons.codec.AbstractByteArrayCodec

com.helger.commons.codec.URLCodec

All Implemented Interfaces:

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

public class URLCodec
extends AbstractByteArrayCodec

Encoder and decoder for URL stuff

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
URLCodec() Default constructor with the UTF-8 charset.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getDecoded(byte[] aEncodedBuffer) Decode a byte array.
static byte[]	getDecodedURL(byte[] aEncodedBuffer)
static byte[]	getDecodedURL(String sEncodedURL)
static String	getDecodedURLString(String sEncodedURL, Charset aDestCharset)
static BitSet	getDefaultBitSet()
byte[]	getEncoded(byte[] aDecodedBuffer) Encode a byte array.
static byte[]	getEncodedURL(BitSet aPrintableBitSet, byte[] aDecodedBuffer)
static byte[]	getEncodedURL(byte[] aDecodedBuffer)
static String	getEncodedURLString(BitSet aPrintableBitSet, byte[] aDecodedBuffer)
static String	getEncodedURLString(BitSet aPrintableBitSet, String sDecodedURL, Charset aSourceCharset)
static String	getEncodedURLString(byte[] aDecodedBuffer)
static String	getEncodedURLString(String sDecodedURL, Charset aSourceCharset)
static void	writeEncodedURLByte(int b, NonBlockingByteArrayOutputStream aBAOS) Encodes byte into its URL representation.

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

getEncoded

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

getDecoded

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

Constructor Detail

URLCodec

public URLCodec()

Default constructor with the UTF-8 charset.

Method Detail

getDefaultBitSet

@Nonnull
@ReturnsMutableCopy
public static BitSet getDefaultBitSet()

Returns:

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

writeEncodedURLByte

public static final void writeEncodedURLByte(int b,
                       @Nonnull
                       NonBlockingByteArrayOutputStream aBAOS)

Encodes byte into its URL representation.

Parameters:

b - byte to encode

aBAOS - the buffer to write to

getEncodedURL

@Nullable
@ReturnsMutableCopy
public static byte[] getEncodedURL(@Nonnull
                                               BitSet aPrintableBitSet,
                                               @Nullable
                                               byte[] aDecodedBuffer)

getEncodedURL

@Nullable
@ReturnsMutableCopy
public static byte[] getEncodedURL(@Nullable
                                               byte[] aDecodedBuffer)

getEncoded

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

Description copied from interface: IByteArrayEncoder

Encode a byte array.

Parameters:

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

Returns:

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

getDecodedURL

@Nullable
@ReturnsMutableCopy
public static byte[] getDecodedURL(@Nullable
                                               byte[] aEncodedBuffer)

getDecodedURL

@Nullable
@ReturnsMutableCopy
public static byte[] getDecodedURL(@Nullable
                                               String sEncodedURL)

getDecoded

@Nullable
@ReturnsMutableCopy
public byte[] getDecoded(@Nullable
                                            byte[] aEncodedBuffer)

Description copied from interface: IByteArrayDecoder

Decode a byte array.

Parameters:

aEncodedBuffer - The byte array to be decoded. May not be null.

Returns:

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

getEncodedURLString

@Nullable
public static String getEncodedURLString(@Nonnull
                                  BitSet aPrintableBitSet,
                                  @Nonnull
                                  byte[] aDecodedBuffer)

getEncodedURLString

@Nullable
public static String getEncodedURLString(@Nonnull
                                  byte[] aDecodedBuffer)

getEncodedURLString

@Nullable
public static String getEncodedURLString(@Nonnull
                                  BitSet aPrintableBitSet,
                                  @Nullable
                                  String sDecodedURL,
                                  @Nonnull
                                  Charset aSourceCharset)

getEncodedURLString

@Nullable
public static String getEncodedURLString(@Nullable
                                  String sDecodedURL,
                                  @Nonnull
                                  Charset aSourceCharset)

getDecodedURLString

@Nullable
public static String getDecodedURLString(@Nullable
                                  String sEncodedURL,
                                  @Nonnull
                                  Charset aDestCharset)