com.mattunderscore.http.headers.content.type

Class QContentType

java.lang.Object

com.mattunderscore.http.headers.content.type.QContentType

All Implemented Interfaces:

HeaderFieldElement, Qualified, Cloneable

public class QContentType
extends Object
implements HeaderFieldElement, Qualified, Cloneable

A parsed accept 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.0.13

Author:

Matt Champion

Field Summary

Fields

Modifier and Type	Field and Description
static QContentType	APP_RDF
static QContentType	APP_XHTML
static QContentType	TEXT_HTML

Constructor Summary

Constructors

Constructor and Description
QContentType(String type, String subType, Map<String,String> parameters, double qualifier) Constructor for qualified content types.

Method Summary

Modifier and Type	Method and Description
QContentType	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<QContentType>	getRequestContentTypes(HttpServletRequest request) Parser for HttpServletRequest to QContentType
int	hashCode()
boolean	isAnySubType() Test to see if the subtype is a wildcard.
boolean	isAnyType() Test to see if the type is a wildcard.
boolean	sameType(QContentType qct) 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

Field Detail

TEXT_HTML

public static final QContentType TEXT_HTML

APP_XHTML

public static final QContentType APP_XHTML

APP_RDF

public static final QContentType APP_RDF

Constructor Detail

QContentType

public QContentType(String type,
                    String subType,
                    Map<String,String> parameters,
                    double qualifier)

Constructor for qualified content types.

Creates an immutable object. The type and subtype may not be null. The value of the qualifier must be between 0.0 and 1.0.

Parameters:

type - Type of the content type

subType - Subtype of the content type

parameters - Map of additional parameters

qualifier - The qualifier of the content type

Throws:

IllegalArgumentException - If type or subtype are null or if the qualifier is less than zero or greater than one

Method Detail

getRequestContentTypes

public static List<QContentType> getRequestContentTypes(HttpServletRequest request)
                                                 throws UnParsableHeaderException

Parser for HttpServletRequest to QContentType

Parameters:

request - The HTTP request to parse

Returns:

The List of content types in the accept header.

Throws:

UnParsableHeaderException

Since:

0.0.13

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()

getQualifier

public final double getQualifier()

Specified by:

getQualifier in interface Qualified

sameType

public final boolean sameType(QContentType qct)

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

Parameters:

qct -

Returns:

True if they match

Since:

0.0.13

isAnySubType

public final boolean isAnySubType()

Test to see if the subtype is a wildcard.

Returns:

True if the sub type is a wildcard

Since:

0.0.13

isAnyType

public boolean isAnyType()

Test to see if the type is a wildcard.

Returns:

True if the type is a wild card.

Since:

0.0.13

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

clone

@Deprecated
public QContentType 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()