com.mattunderscore.http.headers.encoding

Class QEncoding

java.lang.Object

com.mattunderscore.http.headers.encoding.QEncoding

All Implemented Interfaces:

IEncoding, HeaderFieldElement, Qualified, Cloneable

public class QEncoding
extends Object
implements Cloneable, IEncoding

A parsed accept encoding header field value with a qualification value.

The to string value is calculated when first accessed and cached subsequently. The value is checked and set atomically. Concurrent access may cause different String objects to be cached and returned but they will be equal. A happens before relationship is not established by calls to toString().

Since:

0.1.2

Author:

Matt Champion

Constructor Summary

Constructors

Constructor and Description
QEncoding(String encoding, double qualifier) Constructor for qualified encodings.

Method Summary

Modifier and Type	Method and Description
QEncoding	clone() Deprecated. There is not real value in cloning this object, the only mutable value is the cached toString value
boolean	equals(Object object)
double	getQualifier()
static List<IEncoding>	getRequestEncodings(HttpServletRequest request) Parser for HttpServletRequest to QEncoding
int	hashCode()
boolean	isAnyEncoding() Test to see if the encoding is a wildcard.
boolean	sameEncoding(QEncoding encodingObject) Method that returns true if the two content types can be matched against one another.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QEncoding

public QEncoding(String encoding,
                 double qualifier)

Constructor for qualified encodings.

Parameters:

encoding - The encoding

qualifier - The qualifier of the encoding

Throws:

IllegalArgumentException - If the encoding is null or if the qualifier is less than zero or greater than one

Method Detail

getRequestEncodings

public static List<IEncoding> getRequestEncodings(HttpServletRequest request)
                                           throws UnParsableHeaderException

Parser for HttpServletRequest to QEncoding

Parameters:

request - The HTTP request to parse

Returns:

The List of encodings in the accept-encoding header

Throws:

UnParsableHeaderException - If a header cannot be parsed

Since:

0.1.2

getQualifier

public final double getQualifier()

Specified by:

getQualifier in interface Qualified

toString

public String toString()

Returns a string representation of the object.

The string representation of the object is constructed lazily, it may be initialised multiple times and may not be aware of other threads setting it. The objects returned will be equal regardless of the thread returning the value.

Overrides:

toString in class Object

Returns:

A string representation of this object

See Also:

Object.toString()

sameEncoding

public final boolean sameEncoding(QEncoding encodingObject)

Description copied from interface: IEncoding

Method that returns true if the two content types can be matched against one another. Takes into account wildcard matching.

Specified by:

sameEncoding in interface IEncoding

Parameters:

encodingObject - Another encoding

Returns:

True if they can be matched

isAnyEncoding

public final boolean isAnyEncoding()

Description copied from interface: IEncoding

Test to see if the encoding is a wildcard.

Specified by:

isAnyEncoding in interface IEncoding

Returns:

True if the encoding is a wild card.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

clone

@Deprecated
public QEncoding clone()

Deprecated. There is not real value in cloning this object, the only mutable value is the cached toString value

Overrides:

clone in class Object

Returns:

Clone object

See Also:

Object.clone()