Package com.helger.commons.codec

Class RFC2616Codec

java.lang.Object

com.helger.commons.codec.RFC2616Codec

All Implemented Interfaces:

ICharArrayCodec, ICharArrayDecoder, ICharArrayEncoder, ICharArrayStreamDecoder, ICharArrayStreamEncoder, ICodec<char[]>, IDecoder<char[],char[]>, IEncoder<char[],char[]>, Serializable

public class RFC2616Codec
extends Object
implements ICharArrayCodec

Codec for RFC 2616 HTTP header values.

Since:

9.3.6

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
RFC2616Codec()

Method Summary

Modifier and Type	Method	Description
void	decode(char[] aEncodedBuffer, int nOfs, int nLen, Writer aWriter)	Decode (part of) a char array.
void	encode(char[] aDecodedBuffer, int nOfs, int nLen, Writer aWriter)	Encode (part of) a char array to an Writer.
int	getEncodedLength(int nDecodedLen)	Deprecated. Use getMaximumEncodedLength(int)
int	getMaximumDecodedLength(int nEncodedLen)	Get the maximum decoded length based on the provided encoded length.
int	getMaximumEncodedLength(int nDecodedLen)	Get the maximum encoded length based on the provided decoded length.
static boolean	isMaybeEncoded(char[] s)
static boolean	isMaybeEncoded(String s)
static boolean	isToken(char[] aChars)
static boolean	isToken(String s)

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.ICharArrayDecoder

getDecoded, getDecoded

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

decode, getDecoded, getDecodedAsString, getDecodedAsString, getDecodedAsString

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

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

Constructor Detail

RFC2616Codec

public RFC2616Codec()

Method Detail

isToken

public static boolean isToken(@Nullable
                              String s)

isToken

public static boolean isToken(@Nullable
                              char[] aChars)

isMaybeEncoded

public static boolean isMaybeEncoded(@Nullable
                                     String s)

isMaybeEncoded

public static boolean isMaybeEncoded(@Nullable
                                     char[] s)

getEncodedLength

@Nonnegative
@Deprecated
public int getEncodedLength(@Nonnegative
                            int nDecodedLen)

Deprecated.

Use getMaximumEncodedLength(int)

Get the maximum encoded length based on the provided decoded length. This is purely for performance reasons. The name of the method would be better called "getMaximumEncodedLength".

Parameters:

nDecodedLen - The decoded length. Always ≥ 0.

Returns:

The maximum encoded length. Always ≥ 0.

getMaximumEncodedLength

@Nonnegative
public int getMaximumEncodedLength(@Nonnegative
                                   int nDecodedLen)

Description copied from interface: ICharArrayEncoder

Get the maximum encoded length based on the provided decoded length. This is purely for performance reasons. The name of the method would be better called "getMaximumEncodedLength".

Specified by:

getMaximumEncodedLength in interface ICharArrayEncoder

Specified by:

getMaximumEncodedLength in interface ICharArrayStreamEncoder

Parameters:

nDecodedLen - The decoded length. Always ≥ 0.

Returns:

The maximum encoded length. Always ≥ 0.

encode

public void encode(@Nullable
                   char[] aDecodedBuffer,
                   @Nonnegative
                   int nOfs,
                   @Nonnegative
                   int nLen,
                   @Nonnull @WillNotClose
                   Writer aWriter)

Description copied from interface: ICharArrayStreamEncoder

Encode (part of) a char array to an Writer.

Specified by:

encode in interface ICharArrayStreamEncoder

Parameters:

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

nOfs - Offset into the char array to start from.

nLen - Number of chars starting from offset to consider.

aWriter - The writer to write to. May not be null and is NOT closed afterwards!

getMaximumDecodedLength

@Nonnegative
public int getMaximumDecodedLength(@Nonnegative
                                   int nEncodedLen)

Description copied from interface: ICharArrayDecoder

Get the maximum decoded length based on the provided encoded length. This is purely for performance reasons.

Specified by:

getMaximumDecodedLength in interface ICharArrayDecoder

Parameters:

nEncodedLen - The encoded length. Always ≥ 0.

Returns:

The maximum decoded length. Always ≥ 0.

decode

public void decode(@Nullable
                   char[] aEncodedBuffer,
                   @Nonnegative
                   int nOfs,
                   @Nonnegative
                   int nLen,
                   @Nonnull @WillNotClose
                   Writer aWriter)

Description copied from interface: ICharArrayStreamDecoder

Decode (part of) a char array.

Specified by:

decode in interface ICharArrayStreamDecoder

Parameters:

aEncodedBuffer - The char array to be decoded. May be null.

nOfs - Offset into the char array to start from.

nLen - Number of chars starting from offset to consider.

aWriter - The writer to write to. May not be null and is NOT closed afterwards!