Package com.aspectran.web.support.http

Class MediaTypeUtils

java.lang.Object

com.aspectran.web.support.http.MediaTypeUtils

public abstract class MediaTypeUtils
extends java.lang.Object

Miscellaneous MediaType utility methods.

Author:

Arjen Poutsma, Rossen Stoyanchev, Dimitrios Liapis, Brian Clozel

Field Summary

Fields

Modifier and Type	Field	Description
static MediaType	ALL	Public constant media type that includes all media ranges (i.e.
static java.lang.String	ALL_VALUE	A String equivalent of ALL.
static MediaType	APPLICATION_JSON	Public constant media type for application/json.
static java.lang.String	APPLICATION_JSON_VALUE	A String equivalent of APPLICATION_JSON.
static MediaType	APPLICATION_OCTET_STREAM	Public constant media type for application/octet-stream.
static java.lang.String	APPLICATION_OCTET_STREAM_VALUE	A String equivalent of APPLICATION_OCTET_STREAM.
static MediaType	APPLICATION_XML	Public constant media type for application/xml.
static java.lang.String	APPLICATION_XML_VALUE	A String equivalent of APPLICATION_XML.
static MediaType	IMAGE_GIF	Public constant media type for image/gif.
static java.lang.String	IMAGE_GIF_VALUE	A String equivalent of IMAGE_GIF.
static MediaType	IMAGE_JPEG	Public constant media type for image/jpeg.
static java.lang.String	IMAGE_JPEG_VALUE	A String equivalent of IMAGE_JPEG.
static MediaType	IMAGE_PNG	Public constant media type for image/png.
static java.lang.String	IMAGE_PNG_VALUE	A String equivalent of IMAGE_PNG.
static java.util.Comparator<MediaType>	SPECIFICITY_COMPARATOR	Comparator used by sortBySpecificity(List).
static MediaType	TEXT_HTML	Public constant media type for text/html.
static java.lang.String	TEXT_HTML_VALUE	A String equivalent of TEXT_HTML.
static MediaType	TEXT_PLAIN	Public constant media type for text/plain.
static java.lang.String	TEXT_PLAIN_VALUE	A String equivalent of TEXT_PLAIN.
static MediaType	TEXT_XML	Public constant media type for text/xml.
static java.lang.String	TEXT_XML_VALUE	A String equivalent of TEXT_XML.

Constructor Summary

Constructors

Constructor	Description
MediaTypeUtils()

Method Summary

Modifier and Type	Method	Description
static MediaType	parseMediaType(java.lang.String mediaType)	Parse the given String into a single MediaType.
static java.util.List<MediaType>	parseMediaTypes(java.lang.String mediaTypes)	Parse the comma-separated string into a list of MediaType objects.
static void	sortBySpecificity(java.util.List<MediaType> mediaTypes)	Sorts the given list of MediaType objects by specificity.
static java.util.List<java.lang.String>	tokenize(java.lang.String mediaTypes)	Tokenize the given comma-separated string of MediaType objects into a List<String>.
static java.lang.String	toString(java.util.Collection<MediaType> mediaTypes)	Return a string representation of the given list of MediaType objects.

Methods inherited from class java.lang.Object

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

Field Detail

SPECIFICITY_COMPARATOR

public static final java.util.Comparator<MediaType> SPECIFICITY_COMPARATOR

Comparator used by sortBySpecificity(List).

ALL

public static final MediaType ALL

Public constant media type that includes all media ranges (i.e. "*/*").

ALL_VALUE

public static final java.lang.String ALL_VALUE

A String equivalent of ALL.

See Also:

Constant Field Values

APPLICATION_JSON

public static final MediaType APPLICATION_JSON

Public constant media type for application/json.

APPLICATION_JSON_VALUE

public static final java.lang.String APPLICATION_JSON_VALUE

A String equivalent of APPLICATION_JSON.

See Also:

Constant Field Values

APPLICATION_OCTET_STREAM

public static final MediaType APPLICATION_OCTET_STREAM

Public constant media type for application/octet-stream.

APPLICATION_OCTET_STREAM_VALUE

public static final java.lang.String APPLICATION_OCTET_STREAM_VALUE

A String equivalent of APPLICATION_OCTET_STREAM.

See Also:

Constant Field Values

APPLICATION_XML

public static final MediaType APPLICATION_XML

Public constant media type for application/xml.

APPLICATION_XML_VALUE

public static final java.lang.String APPLICATION_XML_VALUE

A String equivalent of APPLICATION_XML.

See Also:

Constant Field Values

IMAGE_GIF

public static final MediaType IMAGE_GIF

Public constant media type for image/gif.

IMAGE_GIF_VALUE

public static final java.lang.String IMAGE_GIF_VALUE

A String equivalent of IMAGE_GIF.

See Also:

Constant Field Values

IMAGE_JPEG

public static final MediaType IMAGE_JPEG

Public constant media type for image/jpeg.

IMAGE_JPEG_VALUE

public static final java.lang.String IMAGE_JPEG_VALUE

A String equivalent of IMAGE_JPEG.

See Also:

Constant Field Values

IMAGE_PNG

public static final MediaType IMAGE_PNG

Public constant media type for image/png.

IMAGE_PNG_VALUE

public static final java.lang.String IMAGE_PNG_VALUE

A String equivalent of IMAGE_PNG.

See Also:

Constant Field Values

TEXT_HTML

public static final MediaType TEXT_HTML

Public constant media type for text/html.

TEXT_HTML_VALUE

public static final java.lang.String TEXT_HTML_VALUE

A String equivalent of TEXT_HTML.

See Also:

Constant Field Values

TEXT_PLAIN

public static final MediaType TEXT_PLAIN

Public constant media type for text/plain.

TEXT_PLAIN_VALUE

public static final java.lang.String TEXT_PLAIN_VALUE

A String equivalent of TEXT_PLAIN.

See Also:

Constant Field Values

TEXT_XML

public static final MediaType TEXT_XML

Public constant media type for text/xml.

TEXT_XML_VALUE

public static final java.lang.String TEXT_XML_VALUE

A String equivalent of TEXT_XML.

See Also:

Constant Field Values

Constructor Detail

MediaTypeUtils

public MediaTypeUtils()

Method Detail

parseMediaType

public static MediaType parseMediaType(java.lang.String mediaType)

Parse the given String into a single MediaType. Recently parsed MediaType are cached for further retrieval.

Parameters:

mediaType - the string to parse

Returns:

the media type

Throws:

InvalidMediaTypeException - if the string cannot be parsed

parseMediaTypes

public static java.util.List<MediaType> parseMediaTypes(java.lang.String mediaTypes)

Parse the comma-separated string into a list of MediaType objects.

Parameters:

mediaTypes - the string to parse

Returns:

the list of media types

Throws:

InvalidMediaTypeException - if the string cannot be parsed

tokenize

public static java.util.List<java.lang.String> tokenize(java.lang.String mediaTypes)

Tokenize the given comma-separated string of MediaType objects into a List<String>. Unlike simple tokenization by ",", this method takes into account quoted parameters.

Parameters:

mediaTypes - the string to tokenize

Returns:

the list of tokens

toString

public static java.lang.String toString(java.util.Collection<MediaType> mediaTypes)

Return a string representation of the given list of MediaType objects.

Parameters:

mediaTypes - the string to parse

Returns:

the list of media types

Throws:

java.lang.IllegalArgumentException - if the String cannot be parsed

sortBySpecificity

public static void sortBySpecificity(java.util.List<MediaType> mediaTypes)

Sorts the given list of MediaType objects by specificity.

Given two media types:

1. if either media type has a wildcard type, then the media type without the wildcard is ordered before the other.
2. if the two media types have different types, then they are considered equal and remain their current order.
3. if either media type has a wildcard subtype , then the media type without the wildcard is sorted before the other.
4. if the two media types have different subtypes, then they are considered equal and remain their current order.
5. if the two media types have a different amount of parameters, then the media type with the most parameters is ordered before the other.

For example:

audio/basic < audio/* < */*

audio/basic;level=1 < audio/basic

audio/basic == text/html

audio/basic == audio/wave

Parameters:

mediaTypes - the list of media types to be sorted

See Also:

HTTP 1.1: Semantics and Content, section 5.3.2