com.phloc.commons.codec

Class URLCodec

java.lang.Object

com.phloc.commons.codec.AbstractCodec

com.phloc.commons.codec.URLCodec

All Implemented Interfaces:

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

public class URLCodec
extends AbstractCodec
implements IStringCodec

Encoder and decoder for URL stuff

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
URLCodec() Default constructor with the UTF-8 charset.
URLCodec(Charset aCharset) Constructor which allows for the selection of a default charset

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	decode(byte[] aEncodedBuffer) Decode a byte array.
String	decodeText(String sEncoded) Decode the passed string.
static String	decodeText(String sEncoded, Charset aCharset)
static byte[]	decodeURL(byte[] aEncodedBuffer)
byte[]	encode(byte[] aDecodedBuffer) Encode a byte array.
String	encodeText(BitSet aBitSet, String sDecoded)
static String	encodeText(BitSet aPrintableBitSet, String sDecoded, Charset aCharset) Encode the passed text using a custom BitSet
String	encodeText(String sDecoded) Encode the passed string.
static String	encodeText(String sDecoded, Charset aCharset) Encode the passed text using the default BitSet.
static byte[]	encodeURL(BitSet aPrintableBitSet, byte[] aDecodedBuffer)
static void	encodeURL(int b, NonBlockingByteArrayOutputStream aBAOS) Encodes byte into its URL representation.
Charset	getCharset() Gets the default charset name used for string decoding and encoding.
static BitSet	getDefaultBitSet()

Methods inherited from class com.phloc.commons.codec.AbstractCodec

decode, encode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.phloc.commons.codec.ICodec

decode, encode

Constructor Detail

URLCodec

public URLCodec()

Default constructor with the UTF-8 charset.

URLCodec

public URLCodec(@Nonnull
        Charset aCharset)

Constructor which allows for the selection of a default charset

Parameters:

aCharset - the default string charset to use.

Method Detail

getCharset

@Nonnull
public Charset getCharset()

Description copied from interface: IStringCodec

Gets the default charset name used for string decoding and encoding.

Specified by:

getCharset in interface IStringCodec

Returns:

the default charset. Never null.

getDefaultBitSet

@Nonnull
@ReturnsMutableCopy
public static BitSet getDefaultBitSet()

Returns:

A copy of the default bit set to be used.

encodeURL

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

Encodes byte into its URL representation.

Parameters:

b - byte to encode

aBAOS - the buffer to write to

encodeURL

@Nonnull
public static byte[] encodeURL(@Nonnull
                       BitSet aPrintableBitSet,
                       @Nonnull
                       byte[] aDecodedBuffer)

encode

@Nullable
public byte[] encode(@Nullable
                     byte[] aDecodedBuffer)

Description copied from interface: IByteArrayEncoder

Encode a byte array.

Specified by:

encode in interface IByteArrayEncoder

Specified by:

encode in interface IEncoder<byte[]>

Parameters:

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

Returns:

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

decodeURL

@Nullable
public static byte[] decodeURL(@Nullable
                        byte[] aEncodedBuffer)

decode

@Nullable
public byte[] decode(@Nullable
                     byte[] aEncodedBuffer)

Description copied from interface: IByteArrayDecoder

Decode a byte array.

Specified by:

decode in interface IByteArrayDecoder

Specified by:

decode in interface IDecoder<byte[]>

Parameters:

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

Returns:

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

encodeText

@Nullable
public String encodeText(@Nullable
                         String sDecoded)

Description copied from interface: IStringCodec

Encode the passed string.

Specified by:

encodeText in interface IStringCodec

Parameters:

sDecoded - The string to be encoded. May be null.

Returns:

null if the input string is null.

encodeText

@Nullable
public String encodeText(@Nonnull
                         BitSet aBitSet,
                         @Nullable
                         String sDecoded)

encodeText

@Nullable
public static String encodeText(@Nullable
                         String sDecoded,
                         @Nonnull
                         Charset aCharset)

Encode the passed text using the default BitSet.

Parameters:

sDecoded - The original string to be encoded. May be null.

aCharset - The charset to be used. May not be null.

Returns:

The encoded string in US-ASCII encoding. May be null if the original string is null.

encodeText

@Nullable
public static String encodeText(@Nonnull
                         BitSet aPrintableBitSet,
                         @Nullable
                         String sDecoded,
                         @Nonnull
                         Charset aCharset)

Encode the passed text using a custom BitSet

Parameters:

aPrintableBitSet - The BitSet with all chars to NOT escape. May not be null.

sDecoded - The original string to be encoded. May be null.

aCharset - The charset to be used. May not be null.

Returns:

The encoded string in US-ASCII encoding. May be null if the original string is null.

decodeText

@Nullable
public String decodeText(@Nullable
                         String sEncoded)

Description copied from interface: IStringCodec

Decode the passed string.

Specified by:

decodeText in interface IStringCodec

Parameters:

sEncoded - The string to be decoded. May be null.

Returns:

null if the input string is null.

decodeText

@Nullable
public static String decodeText(@Nullable
                         String sEncoded,
                         @Nonnull
                         Charset aCharset)