org.apache.juneau.http

Class MediaTypeRange

java.lang.Object

org.apache.juneau.http.MediaTypeRange

All Implemented Interfaces:

Comparable<MediaTypeRange>

@BeanIgnore
public final class MediaTypeRange
extends Object
implements Comparable<MediaTypeRange>

Describes a single type used in content negotiation between an HTTP client and server, as described in Section 14.1 and 14.7 of RFC2616 (the HTTP/1.1 specification).

• Hypertext Transfer Protocol -- HTTP/1.1

Method Summary

Modifier and Type	Method and Description
int	compareTo(MediaTypeRange o) Compares two MediaRanges for equality.
boolean	equals(Object o) Returns true if the specified object is also a MediaType, and has the same qValue, type, parameters, and extensions.
Map<String,Set<String>>	getExtensions() Returns the optional set of custom extensions defined for this type.
MediaType	getMediaType() Returns the media type enclosed by this media range.
Float	getQValue() Returns the 'q' (quality) value for this type, as described in Section 3.9 of RFC2616.
int	hashCode() Returns a hash based on this instance's media-type.
static MediaTypeRange[]	parse(String value) Parses an Accept header value into an array of media ranges.
String	toString() Provides a string representation of this media range, suitable for use as an Accept header value.

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static MediaTypeRange[] parse(String value)

Parses an Accept header value into an array of media ranges.

The returned media ranges are sorted such that the most acceptable media is available at ordinal position '0', and the least acceptable at position n-1.

The syntax expected to be found in the referenced value complies with the syntax described in RFC2616, Section 14.1, as described below:

Accept = "Accept" ":" #( media-range [ accept-params ] ) media-range = ( "*\/*" | ( type "/" "*" ) | ( type "/" subtype ) ) *( ";" parameter ) accept-params = ";" "q" "=" qvalue *( accept-extension ) accept-extension = ";" token [ "=" ( token | quoted-string ) ]

Parameters:

value - The value to parse. If null or empty, returns a single MediaTypeRange is returned that represents all types.

Returns:

The media ranges described by the string. The ranges are sorted such that the most acceptable media is available at ordinal position '0', and the least acceptable at position n-1.

getMediaType

public MediaType getMediaType()

Returns the media type enclosed by this media range.

Examples:

• "text/html"
• "text/*"
• "*\/*"

Returns:

The media type of this media range, lowercased, never null.

getQValue

public Float getQValue()

Returns the 'q' (quality) value for this type, as described in Section 3.9 of RFC2616.

The quality value is a float between 0.0 (unacceptable) and 1.0 (most acceptable).

If 'q' value doesn't make sense for the context (e.g. this range was extracted from a "content-*" header, as opposed to "accept-*" header, its value will always be "1".

Returns:

The 'q' value for this type, never null.

getExtensions

public Map<String,Set<String>> getExtensions()

Returns the optional set of custom extensions defined for this type.

Values are lowercase and never null.

Returns:

The optional list of extensions, never null.

toString

public String toString()

Provides a string representation of this media range, suitable for use as an Accept header value.

The literal text generated will be all lowercase.

Overrides:

toString in class Object

Returns:

A media range suitable for use as an Accept header value, never null.

equals

public boolean equals(Object o)

Returns true if the specified object is also a MediaType, and has the same qValue, type, parameters, and extensions.

Overrides:

equals in class Object

Returns:

true if object is equivalent.

hashCode

public int hashCode()

Returns a hash based on this instance's media-type.

Overrides:

hashCode in class Object

Returns:

A hash based on this instance's media-type.

compareTo

public int compareTo(MediaTypeRange o)

Compares two MediaRanges for equality.

The values are first compared according to qValue values. Should those values be equal, the type is then lexicographically compared (case-insensitive) in ascending order, with the "*" type demoted last in that order. MediaRanges with the same type but different sub-types are compared - a more specific subtype is promoted over the 'wildcard' subtype. MediaRanges with the same types but with extensions are promoted over those same types with no extensions.

Specified by:

compareTo in interface Comparable<MediaTypeRange>

Parameters:

o - The range to compare to. Never null.