MediaType (bboss-util 5.2.7 API)

java.lang.Object
- org.frameworkset.http.MimeType
- - org.frameworkset.http.MediaType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MimeType>
```
public class MediaType
extends MimeType
implements java.io.Serializable
```
A sub-class of MimeType that adds support for quality parameters as defined in the HTTP specification.

Since:

3.0

See Also:

HTTP 1.1: Semantics and Content, section 3.1.1.1, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.frameworkset.http.MimeType
  MimeType.SpecificityComparator<T extends MimeType>

Field Summary

Fields
Modifier and Type	Field and 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_ATOM_XML` Public constant media type for `application/atom+xml`.
`static java.lang.String`	`APPLICATION_ATOM_XML_VALUE` A String equivalent of `APPLICATION_ATOM_XML`.
`static MediaType`	`APPLICATION_FORM_URLENCODED` Public constant media type for `application/x-www-form-urlencoded`.
`static java.lang.String`	`APPLICATION_FORM_URLENCODED_VALUE` A String equivalent of `APPLICATION_FORM_URLENCODED`.
`static MediaType`	`APPLICATION_JSON` Public constant media type for `application/json`.
`static MediaType`	`APPLICATION_JSON_UTF8` Public constant media type for `application/json;charset=UTF-8`.
`static java.lang.String`	`APPLICATION_JSON_UTF8_VALUE` A String equivalent of `APPLICATION_JSON_UTF8`.
`static java.lang.String`	`APPLICATION_JSON_VALUE`
`static MediaType`	`APPLICATION_JSONP`
`static java.lang.String`	`APPLICATION_JSONP_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_XHTML_XML` Public constant media type for `application/xhtml+xml`.
`static java.lang.String`	`APPLICATION_XHTML_XML_VALUE` A String equivalent of `APPLICATION_XHTML_XML`.
`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 MediaType`	`MULTIPART_FORM_DATA` Public constant media type for `multipart/form-data`.
`static java.lang.String`	`MULTIPART_FORM_DATA_VALUE` A String equivalent of `MULTIPART_FORM_DATA`.
`static java.util.Comparator<MediaType>`	`QUALITY_VALUE_COMPARATOR` Comparator used by `sortByQualityValue(List)`.
`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`.

Fields inherited from class org.frameworkset.http.MimeType
WILDCARD_TYPE

Constructor Summary

Constructors
Constructor and Description
`MediaType(MediaType other, java.util.Map<java.lang.String,java.lang.String> parameters)` Copy-constructor that copies the type and subtype of the given `MediaType`, and allows for different parameter.
`MediaType(java.lang.String type)` Create a new `MediaType` for the given primary type.
`MediaType(java.lang.String type, java.lang.String subtype)` Create a new `MediaType` for the given primary type and subtype.
`MediaType(java.lang.String type, java.lang.String subtype, java.nio.charset.Charset charset)` Create a new `MediaType` for the given type, subtype, and character set.
`MediaType(java.lang.String type, java.lang.String subtype, double qualityValue)` Create a new `MediaType` for the given type, subtype, and quality value.
`MediaType(java.lang.String type, java.lang.String subtype, java.util.Map<java.lang.String,java.lang.String> parameters)` Create a new `MediaType` for the given type, subtype, and parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkParameters(java.lang.String attribute, java.lang.String value)`
`static MediaType`	`convertMediaType(java.lang.String type, java.lang.String charset)`
`MediaType`	`copyQualityValue(MediaType mediaType)` Return a replica of this instance with the quality value of the given MediaType.
`double`	`getQualityValue()` Return the quality value, as indicated by a `q` parameter, if any.
`boolean`	`includes(MediaType other)` Indicate whether this `MediaType` includes the given media type.
`boolean`	`isCompatibleWith(MediaType other)` Indicate whether this `MediaType` is compatible with the given media type.
`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 given, comma-separated string into a list of `MediaType` objects.
`MediaType`	`removeQualityValue()` Return a replica of this instance with its quality value removed.
`static void`	`sortByQualityValue(java.util.List<MediaType> mediaTypes)` Sorts the given list of `MediaType` objects by quality value.
`static void`	`sortBySpecificity(java.util.List<MediaType> mediaTypes)` Sorts the given list of `MediaType` objects by specificity.
`static void`	`sortBySpecificityAndQuality(java.util.List<MediaType> mediaTypes)` Sorts the given list of `MediaType` objects by specificity as the primary criteria and quality value the secondary.
`static java.lang.String`	`toString(java.util.Collection<MediaType> mediaTypes)` Return a string representation of the given list of `MediaType` objects.
`static MediaType`	`valueOf(java.lang.String value)` Parse the given String value into a `MediaType` object, with this method name following the 'valueOf' naming convention (as supported by `org.frameworkset.core.convert.ConversionService`.

Methods inherited from class org.frameworkset.http.MimeType
appendTo, compareTo, equals, getCharSet, getParameter, getParameters, getSubtype, getType, hashCode, includes, isCompatibleWith, isConcrete, isJson, isJsonp, isWildcardSubtype, isWildcardType, isXml, toString, unquote

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - 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_ATOM_XML
```
public static final MediaType APPLICATION_ATOM_XML
```
    Public constant media type for application/atom+xml.
  - APPLICATION_ATOM_XML_VALUE
```
public static final java.lang.String APPLICATION_ATOM_XML_VALUE
```
    A String equivalent of APPLICATION_ATOM_XML.
    
    See Also:
    
    Constant Field Values
  - APPLICATION_FORM_URLENCODED
```
public static final MediaType APPLICATION_FORM_URLENCODED
```
    Public constant media type for application/x-www-form-urlencoded.
  - APPLICATION_FORM_URLENCODED_VALUE
```
public static final java.lang.String APPLICATION_FORM_URLENCODED_VALUE
```
    A String equivalent of APPLICATION_FORM_URLENCODED.
    
    See Also:
    
    Constant Field Values
  - APPLICATION_JSON
```
public static final MediaType APPLICATION_JSON
```
    Public constant media type for application/json.
    
    See Also:
    
    APPLICATION_JSON_UTF8
  - APPLICATION_JSONP_VALUE
```
public static final java.lang.String APPLICATION_JSONP_VALUE
```
    A String equivalent of APPLICATION_JSON.
    
    See Also:
    
    APPLICATION_JSON_UTF8_VALUE, Constant Field Values
  - APPLICATION_JSON_VALUE
```
public static final java.lang.String APPLICATION_JSON_VALUE
```
    See Also:
    
    Constant Field Values
  - APPLICATION_JSONP
```
public static final MediaType APPLICATION_JSONP
```
  - APPLICATION_JSON_UTF8
```
public static final MediaType APPLICATION_JSON_UTF8
```
    Public constant media type for application/json;charset=UTF-8.
  - APPLICATION_JSON_UTF8_VALUE
```
public static final java.lang.String APPLICATION_JSON_UTF8_VALUE
```
    A String equivalent of APPLICATION_JSON_UTF8.
    
    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_XHTML_XML
```
public static final MediaType APPLICATION_XHTML_XML
```
    Public constant media type for application/xhtml+xml.
  - APPLICATION_XHTML_XML_VALUE
```
public static final java.lang.String APPLICATION_XHTML_XML_VALUE
```
    A String equivalent of APPLICATION_XHTML_XML.
    
    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
  - MULTIPART_FORM_DATA
```
public static final MediaType MULTIPART_FORM_DATA
```
    Public constant media type for multipart/form-data.
  - MULTIPART_FORM_DATA_VALUE
```
public static final java.lang.String MULTIPART_FORM_DATA_VALUE
```
    A String equivalent of MULTIPART_FORM_DATA.
    
    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
  - QUALITY_VALUE_COMPARATOR
```
public static final java.util.Comparator<MediaType> QUALITY_VALUE_COMPARATOR
```
    Comparator used by sortByQualityValue(List).
  - SPECIFICITY_COMPARATOR
```
public static final java.util.Comparator<MediaType> SPECIFICITY_COMPARATOR
```
    Comparator used by sortBySpecificity(List).
- Constructor Detail
  - MediaType
```
public MediaType(java.lang.String type)
```
    Create a new MediaType for the given primary type.
    The subtype is set to "*", parameters empty.
    
    Parameters:
    
    type - the primary type
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the parameters contain illegal characters
  - MediaType
```
public MediaType(java.lang.String type,
                 java.lang.String subtype)
```
    Create a new MediaType for the given primary type and subtype.
    The parameters are empty.
    
    Parameters:
    
    type - the primary type
    
    subtype - the subtype
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the parameters contain illegal characters
  - MediaType
```
public MediaType(java.lang.String type,
                 java.lang.String subtype,
                 java.nio.charset.Charset charset)
```
    Create a new MediaType for the given type, subtype, and character set.
    
    Parameters:
    
    type - the primary type
    
    subtype - the subtype
    
    charset - the character set
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the parameters contain illegal characters
  - MediaType
```
public MediaType(java.lang.String type,
                 java.lang.String subtype,
                 double qualityValue)
```
    Create a new MediaType for the given type, subtype, and quality value.
    
    Parameters:
    
    type - the primary type
    
    subtype - the subtype
    
    qualityValue - the quality value
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the parameters contain illegal characters
  - MediaType
```
public MediaType(MediaType other,
                 java.util.Map<java.lang.String,java.lang.String> parameters)
```
    Copy-constructor that copies the type and subtype of the given MediaType, and allows for different parameter.
    
    Parameters:
    
    other - the other media type
    
    parameters - the parameters, may be null
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the parameters contain illegal characters
  - MediaType
```
public MediaType(java.lang.String type,
                 java.lang.String subtype,
                 java.util.Map<java.lang.String,java.lang.String> parameters)
```
    Create a new MediaType for the given type, subtype, and parameters.
    
    Parameters:
    
    type - the primary type
    
    subtype - the subtype
    
    parameters - the parameters, may be null
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the parameters contain illegal characters
- Method Detail
  - checkParameters
```
protected void checkParameters(java.lang.String attribute,
                               java.lang.String value)
```
    Overrides:
    
    checkParameters in class MimeType
  - getQualityValue
```
public double getQualityValue()
```
    Return the quality value, as indicated by a q parameter, if any. Defaults to 1.0.
    
    Returns:
    
    the quality factory
  - includes
```
public boolean includes(MediaType other)
```
    Indicate whether this MediaType includes the given media type.
    For instance, text/* includes text/plain and text/html, and application/*+xml includes application/soap+xml, etc. This method is not symmetric.
    
    Parameters:
    
    other - the reference media type with which to compare
    
    Returns:
    
    true if this media type includes the given media type; false otherwise
  - isCompatibleWith
```
public boolean isCompatibleWith(MediaType other)
```
    Indicate whether this MediaType is compatible with the given media type.
    For instance, text/* is compatible with text/plain, text/html, and vice versa. In effect, this method is similar to includes(MediaType), except that it is symmetric.
    
    Parameters:
    
    other - the reference media type with which to compare
    
    Returns:
    
    true if this media type is compatible with the given media type; false otherwise
  - copyQualityValue
```
public MediaType copyQualityValue(MediaType mediaType)
```
    Return a replica of this instance with the quality value of the given MediaType.
    
    Returns:
    
    the same instance if the given MediaType doesn't have a quality value, or a new one otherwise
  - removeQualityValue
```
public MediaType removeQualityValue()
```
    Return a replica of this instance with its quality value removed.
    
    Returns:
    
    the same instance if the media type doesn't contain a quality value, or a new one otherwise
  - valueOf
```
public static MediaType valueOf(java.lang.String value)
```
    Parse the given String value into a MediaType object, with this method name following the 'valueOf' naming convention (as supported by org.frameworkset.core.convert.ConversionService.
    
    See Also:
    
    parseMediaType(String)
  - parseMediaType
```
public static MediaType parseMediaType(java.lang.String mediaType)
```
    Parse the given String into a single MediaType.
    
    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 given, comma-separated string into a list of MediaType objects.
    This method can be used to parse an Accept or Content-Type header.
    
    Parameters:
    
    mediaTypes - the string to parse
    
    Returns:
    
    the list of media types
    
    Throws:
    
    java.lang.IllegalArgumentException - if the string cannot be parsed
  - toString
```
public static java.lang.String toString(java.util.Collection<MediaType> mediaTypes)
```
    Return a string representation of the given list of MediaType objects.
    This method can be used to for an Accept or Content-Type header.
    
    Parameters:
    
    mediaTypes - the media types to create a string representation for
    
    Returns:
    
    the string representation
  - 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 different quality value, then the media type with the highest quality value is ordered before the other.
    6. 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/* < audio/*;q=0.7; audio/*;q=0.3
    
    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
  - sortByQualityValue
```
public static void sortByQualityValue(java.util.List<MediaType> mediaTypes)
```
    Sorts the given list of MediaType objects by quality value.
    Given two media types:
    1. if the two media types have different quality value, then the media type with the highest quality value is ordered before the other.
    2. if either media type has a wildcard type, then the media type without the wildcard is ordered before the other.
    3. if the two media types have different types, then they are considered equal and remain their current order.
    4. if either media type has a wildcard subtype, then the media type without the wildcard is sorted before the other.
    5. if the two media types have different subtypes, then they are considered equal and remain their current order.
    6. if the two media types have a different amount of parameters, then the media type with the most parameters is ordered before the other.
    Parameters:
    
    mediaTypes - the list of media types to be sorted
    
    See Also:
    
    getQualityValue()
  - sortBySpecificityAndQuality
```
public static void sortBySpecificityAndQuality(java.util.List<MediaType> mediaTypes)
```
    Sorts the given list of MediaType objects by specificity as the primary criteria and quality value the secondary.
    
    See Also:
    
    sortBySpecificity(List), sortByQualityValue(List)
  - convertMediaType
```
public static MediaType convertMediaType(java.lang.String type,
                                         java.lang.String charset)
```

Class MediaType

Nested Class Summary

Nested classes/interfaces inherited from class org.frameworkset.http.MimeType

Field Summary

Fields inherited from class org.frameworkset.http.MimeType

Constructor Summary

Method Summary

Methods inherited from class org.frameworkset.http.MimeType

Methods inherited from class java.lang.Object

Field Detail

ALL

ALL_VALUE

APPLICATION_ATOM_XML

APPLICATION_ATOM_XML_VALUE

APPLICATION_FORM_URLENCODED

APPLICATION_FORM_URLENCODED_VALUE

APPLICATION_JSON

APPLICATION_JSONP_VALUE

APPLICATION_JSON_VALUE

APPLICATION_JSONP

APPLICATION_JSON_UTF8

APPLICATION_JSON_UTF8_VALUE

APPLICATION_OCTET_STREAM

APPLICATION_OCTET_STREAM_VALUE

APPLICATION_XHTML_XML

APPLICATION_XHTML_XML_VALUE

APPLICATION_XML

APPLICATION_XML_VALUE

IMAGE_GIF

IMAGE_GIF_VALUE

IMAGE_JPEG

IMAGE_JPEG_VALUE

IMAGE_PNG

IMAGE_PNG_VALUE

MULTIPART_FORM_DATA

MULTIPART_FORM_DATA_VALUE

TEXT_HTML

TEXT_HTML_VALUE

TEXT_PLAIN

TEXT_PLAIN_VALUE

TEXT_XML

TEXT_XML_VALUE

QUALITY_VALUE_COMPARATOR

SPECIFICITY_COMPARATOR

Constructor Detail

MediaType

MediaType

MediaType

MediaType

MediaType

MediaType

Method Detail

checkParameters

getQualityValue

includes

isCompatibleWith

copyQualityValue

removeQualityValue

valueOf

parseMediaType

parseMediaTypes

toString

sortBySpecificity

sortByQualityValue

sortBySpecificityAndQuality

convertMediaType