JavaEE API 8.0.1 · javax.ws.rs.core.MediaType

Field Summary

Modifier and Type	Field and Description
public static final String	APPLICATION_ATOM_XML A `String` constant representing application/atom+xml media type.
public static final MediaType	APPLICATION_ATOM_XML_TYPE A `MediaType` constant representing application/atom+xml media type.
public static final String	APPLICATION_FORM_URLENCODED A `String` constant representing application/x-www-form-urlencoded media type.
public static final MediaType	APPLICATION_FORM_URLENCODED_TYPE A `MediaType` constant representing application/x-www-form-urlencoded media type.
public static final String	APPLICATION_JSON A `String` constant representing application/json media type.
public static final String	APPLICATION_JSON_PATCH_JSON `String` representation of application/json-patch+json media type..
public static final MediaType	APPLICATION_JSON_PATCH_JSON_TYPE A `MediaType` constant representing application/json-patch+json media type.
public static final MediaType	APPLICATION_JSON_TYPE A `MediaType` constant representing application/json media type.
public static final String	APPLICATION_OCTET_STREAM A `String` constant representing application/octet-stream media type.
public static final MediaType	APPLICATION_OCTET_STREAM_TYPE A `MediaType` constant representing application/octet-stream media type.
public static final String	APPLICATION_SVG_XML A `String` constant representing application/svg+xml media type.
public static final MediaType	APPLICATION_SVG_XML_TYPE A `MediaType` constant representing application/svg+xml media type.
public static final String	APPLICATION_XHTML_XML A `String` constant representing application/xhtml+xml media type.
public static final MediaType	APPLICATION_XHTML_XML_TYPE A `MediaType` constant representing application/xhtml+xml media type.
public static final String	APPLICATION_XML A `String` constant representing application/xml media type.
public static final MediaType	APPLICATION_XML_TYPE A `MediaType` constant representing application/xml media type.
public static final String	CHARSET_PARAMETER The media type `charset` parameter name.
public static final String	MEDIA_TYPE_WILDCARD The value of a type or subtype wildcard *.
public static final String	MULTIPART_FORM_DATA A `String` constant representing multipart/form-data media type.
public static final MediaType	MULTIPART_FORM_DATA_TYPE A `MediaType` constant representing multipart/form-data media type.
private Map<String, String>	parameters
public static final String	SERVER_SENT_EVENTS `String` representation of Server sent events media type.
public static final MediaType	SERVER_SENT_EVENTS_TYPE Server sent events media type.
private String	subtype
public static final String	TEXT_HTML A `String` constant representing text/html media type.
public static final MediaType	TEXT_HTML_TYPE A `MediaType` constant representing text/html media type.
public static final String	TEXT_PLAIN A `String` constant representing text/plain media type.
public static final MediaType	TEXT_PLAIN_TYPE A `MediaType` constant representing text/plain media type.
public static final String	TEXT_XML A `String` constant representing text/xml media type.
public static final MediaType	TEXT_XML_TYPE A `MediaType` constant representing text/xml media type.
private String	type
public static final String	WILDCARD A `String` constant representing wildcard / media type .
public static final MediaType	WILDCARD_TYPE A `MediaType` constant representing wildcard / media type.

Constructor Summary

Access	Constructor and Description
public	MediaType(String the primary type, `null` is equivalent to `MEDIA_TYPE_WILDCARD`. type, String the subtype, `null` is equivalent to `MEDIA_TYPE_WILDCARD`. subtype, Map<String, String> a map of media type parameters, `null` is the same as an empty map. parameters) Creates a new instance of `MediaType` with the supplied type, subtype and parameters.
public	MediaType(String the primary type, `null` is equivalent to `MEDIA_TYPE_WILDCARD` type, String the subtype, `null` is equivalent to `MEDIA_TYPE_WILDCARD` subtype) Creates a new instance of `MediaType` with the supplied type and subtype.
public	MediaType(String the primary type, `null` is equivalent to `MEDIA_TYPE_WILDCARD` type, String the subtype, `null` is equivalent to `MEDIA_TYPE_WILDCARD` subtype, String the charset parameter value. If `null` or empty the charset parameter will not be set. charset) Creates a new instance of `MediaType` with the supplied type, subtype and charset parameter.
public	MediaType() Creates a new instance of `MediaType`, both type and subtype are wildcards.
private	MediaType(String type, String subtype, String charset, Map<String, String> parameterMap)

Method Summary

Modifier and Type	Method and Description
private static TreeMap<String, String>	createParametersMap(Map<String, String> initialValues)
public boolean	Returns: true if the two media types are the same, false otherwise. equals(Object the object to compare to. obj) Overrides java.lang.Object.equals. Compares `obj` to this media type to see if they are the same by comparing type, subtype and parameters.
public Map<String, String>	Returns: an immutable map of parameters. getParameters() Getter for a read-only parameter map.
public String	Returns: value of subtype. getSubtype() Getter for subtype.
public String	Returns: value of primary type. getType() Getter for primary type.
public int	Returns: a generated hash code. hashCode() Overrides java.lang.Object.hashCode. Generate a hash code from the type, subtype and parameters.
public boolean	Returns: true if the types are compatible, false otherwise. isCompatible(MediaType the media type to compare with. other) Check if this media type is compatible with another media type.
public boolean	Returns: true if the subtype is a wildcard. isWildcardSubtype() Checks if the subtype is a wildcard.
public boolean	Returns: true if the primary type is a wildcard. isWildcardType() Checks if the primary type is a wildcard.
public String	Returns: a string version of the media type. toString() Overrides java.lang.Object.toString. Convert the media type to a string suitable for use as the value of a corresponding HTTP header.
public static MediaType	Returns: the newly created MediaType. valueOf(String the media type string. type) Creates a new instance of `MediaType` by parsing the supplied string.
public MediaType	Returns: copy of the current `MediaType` instance with the charset parameter set to the supplied value. withCharset(String the charset parameter value. If `null` or empty the charset parameter will not be set or updated. charset) Create a new `MediaType` instance with the same type, subtype and parameters copied from the original instance and the supplied charset parameter.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

APPLICATION_ATOM_XML	back to summary
public static final String APPLICATION_ATOM_XML A `String` constant representing application/atom+xml media type.

APPLICATION_ATOM_XML_TYPE	back to summary
public static final MediaType APPLICATION_ATOM_XML_TYPE A `MediaType` constant representing application/atom+xml media type.

APPLICATION_FORM_URLENCODED	back to summary
public static final String APPLICATION_FORM_URLENCODED A `String` constant representing application/x-www-form-urlencoded media type.

APPLICATION_FORM_URLENCODED_TYPE	back to summary
public static final MediaType APPLICATION_FORM_URLENCODED_TYPE A `MediaType` constant representing application/x-www-form-urlencoded media type.

APPLICATION_JSON	back to summary
public static final String APPLICATION_JSON A `String` constant representing application/json media type.

APPLICATION_JSON_PATCH_JSON	back to summary
public static final String APPLICATION_JSON_PATCH_JSON `String` representation of application/json-patch+json media type..

APPLICATION_JSON_PATCH_JSON_TYPE	back to summary
public static final MediaType APPLICATION_JSON_PATCH_JSON_TYPE A `MediaType` constant representing application/json-patch+json media type.

APPLICATION_JSON_TYPE	back to summary
public static final MediaType APPLICATION_JSON_TYPE A `MediaType` constant representing application/json media type.

APPLICATION_OCTET_STREAM	back to summary
public static final String APPLICATION_OCTET_STREAM A `String` constant representing application/octet-stream media type.

APPLICATION_OCTET_STREAM_TYPE	back to summary
public static final MediaType APPLICATION_OCTET_STREAM_TYPE A `MediaType` constant representing application/octet-stream media type.

APPLICATION_SVG_XML	back to summary
public static final String APPLICATION_SVG_XML A `String` constant representing application/svg+xml media type.

APPLICATION_SVG_XML_TYPE	back to summary
public static final MediaType APPLICATION_SVG_XML_TYPE A `MediaType` constant representing application/svg+xml media type.

APPLICATION_XHTML_XML	back to summary
public static final String APPLICATION_XHTML_XML A `String` constant representing application/xhtml+xml media type.

APPLICATION_XHTML_XML_TYPE	back to summary
public static final MediaType APPLICATION_XHTML_XML_TYPE A `MediaType` constant representing application/xhtml+xml media type.

APPLICATION_XML	back to summary
public static final String APPLICATION_XML A `String` constant representing application/xml media type.

APPLICATION_XML_TYPE	back to summary
public static final MediaType APPLICATION_XML_TYPE A `MediaType` constant representing application/xml media type.

CHARSET_PARAMETER	back to summary
public static final String CHARSET_PARAMETER The media type `charset` parameter name.

MEDIA_TYPE_WILDCARD	back to summary
public static final String MEDIA_TYPE_WILDCARD The value of a type or subtype wildcard *.

MULTIPART_FORM_DATA	back to summary
public static final String MULTIPART_FORM_DATA A `String` constant representing multipart/form-data media type.

MULTIPART_FORM_DATA_TYPE	back to summary
public static final MediaType MULTIPART_FORM_DATA_TYPE A `MediaType` constant representing multipart/form-data media type.

parameters	back to summary
private Map<String, String> parameters

SERVER_SENT_EVENTS	back to summary
public static final String SERVER_SENT_EVENTS `String` representation of Server sent events media type. ("text/event-stream").

SERVER_SENT_EVENTS_TYPE	back to summary
public static final MediaType SERVER_SENT_EVENTS_TYPE Server sent events media type.

subtype	back to summary
private String subtype

TEXT_HTML	back to summary
public static final String TEXT_HTML A `String` constant representing text/html media type.

TEXT_HTML_TYPE	back to summary
public static final MediaType TEXT_HTML_TYPE A `MediaType` constant representing text/html media type.

TEXT_PLAIN	back to summary
public static final String TEXT_PLAIN A `String` constant representing text/plain media type.

TEXT_PLAIN_TYPE	back to summary
public static final MediaType TEXT_PLAIN_TYPE A `MediaType` constant representing text/plain media type.

TEXT_XML	back to summary
public static final String TEXT_XML A `String` constant representing text/xml media type.

TEXT_XML_TYPE	back to summary
public static final MediaType TEXT_XML_TYPE A `MediaType` constant representing text/xml media type.

type	back to summary
private String type

WILDCARD	back to summary
public static final String WILDCARD A `String` constant representing wildcard / media type .

WILDCARD_TYPE	back to summary
public static final MediaType WILDCARD_TYPE A `MediaType` constant representing wildcard / media type.

Constructor Detail

MediaType back to summary

MediaType	back to summary
public MediaType(String type, String subtype, Map<String, String> parameters) Creates a new instance of `MediaType` with the supplied type, subtype and parameters. Parameters type:String the primary type, `null` is equivalent to `MEDIA_TYPE_WILDCARD`. subtype:String the subtype, `null` is equivalent to `MEDIA_TYPE_WILDCARD`. parameters:Map<String, String> a map of media type parameters, `null` is the same as an empty map.

public MediaType(String type, String subtype, Map<String, String> parameters)

Creates a new instance of MediaType with the supplied type, subtype and parameters.

Parameters

type:String: the primary type, null is equivalent to MEDIA_TYPE_WILDCARD.
subtype:String: the subtype, null is equivalent to MEDIA_TYPE_WILDCARD.
parameters:Map<String, String>: a map of media type parameters, null is the same as an empty map.

MediaType back to summary

MediaType	back to summary
public MediaType(String type, String subtype) Creates a new instance of `MediaType` with the supplied type and subtype. Parameters type:String the primary type, `null` is equivalent to `MEDIA_TYPE_WILDCARD` subtype:String the subtype, `null` is equivalent to `MEDIA_TYPE_WILDCARD`

public MediaType(String type, String subtype)

Creates a new instance of MediaType with the supplied type and subtype.

Parameters

type:String: the primary type, null is equivalent to MEDIA_TYPE_WILDCARD
subtype:String: the subtype, null is equivalent to MEDIA_TYPE_WILDCARD

MediaType back to summary

MediaType	back to summary
public MediaType(String type, String subtype, String charset) Creates a new instance of `MediaType` with the supplied type, subtype and charset parameter. Parameters type:String the primary type, `null` is equivalent to `MEDIA_TYPE_WILDCARD` subtype:String the subtype, `null` is equivalent to `MEDIA_TYPE_WILDCARD` charset:String the charset parameter value. If `null` or empty the charset parameter will not be set.

public MediaType(String type, String subtype, String charset)

Creates a new instance of MediaType with the supplied type, subtype and charset parameter.

Parameters

type:String: the primary type, null is equivalent to MEDIA_TYPE_WILDCARD
subtype:String: the subtype, null is equivalent to MEDIA_TYPE_WILDCARD
charset:String: the charset parameter value. If null or empty the charset parameter will not be set.

MediaType	back to summary
public MediaType() Creates a new instance of `MediaType`, both type and subtype are wildcards. Consider using the constant `WILDCARD_TYPE` instead.

MediaType	back to summary
private MediaType(String type, String subtype, String charset, Map<String, String> parameterMap)

Method Detail

createParametersMap	back to summary
private static TreeMap<String, String> createParametersMap(Map<String, String> initialValues)

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Compares `obj` to this media type to see if they are the same by comparing type, subtype and parameters. Note that the case-sensitivity of parameter values is dependent on the semantics of the parameter name, see `href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7">HTTP/1.1</a>`. This method assumes that values are case-sensitive. Note that the `equals(...)` implementation does not perform a class equality check (`this.getClass() == obj.getClass()`). Therefore any class that extends from `MediaType` class and needs to override one of the `equals(...)` and `hashCode()` methods must always override both methods to ensure the contract between `Object#equals(java.lang.Object)` and `Object#hashCode()` does not break. Parameters obj:Object the object to compare to. Returns:boolean true if the two media types are the same, false otherwise. Annotations @SuppressWarnings:UnnecessaryJavaDocLink @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Compares obj to this media type to see if they are the same by comparing type, subtype and parameters. Note that the case-sensitivity of parameter values is dependent on the semantics of the parameter name, see href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7">HTTP/1.1</a>. This method assumes that values are case-sensitive.

Note that the equals(...) implementation does not perform a class equality check (this.getClass() == obj.getClass()). Therefore any class that extends from MediaType class and needs to override one of the equals(...) and hashCode() methods must always override both methods to ensure the contract between Object#equals(java.lang.Object) and Object#hashCode() does not break.

Parameters

obj:Object: the object to compare to.

Returns:boolean

true if the two media types are the same, false otherwise.

Annotations

@SuppressWarnings:UnnecessaryJavaDocLink
@Override

getParameters	back to summary
public Map<String, String> getParameters() Getter for a read-only parameter map. Keys are case-insensitive. Returns:Map<String, String> an immutable map of parameters.

getParameters

back to summary

public Map<String, String> getParameters()

Getter for a read-only parameter map. Keys are case-insensitive.

Returns:Map<String, String>: an immutable map of parameters.

getSubtype	back to summary
public String getSubtype() Getter for subtype. Returns:String value of subtype.

getSubtype

back to summary

public String getSubtype()

Getter for subtype.

Returns:String: value of subtype.

getType	back to summary
public String getType() Getter for primary type. Returns:String value of primary type.

getType

back to summary

public String getType()

Getter for primary type.

Returns:String: value of primary type.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Generate a hash code from the type, subtype and parameters. Note that the `equals(java.lang.Object)` implementation does not perform a class equality check (`this.getClass() == obj.getClass()`). Therefore any class that extends from `MediaType` class and needs to override one of the `equals(Object)` and `hashCode()` methods must always override both methods to ensure the contract between `Object#equals(java.lang.Object)` and `Object#hashCode()` does not break. Returns:int a generated hash code. Annotations @SuppressWarnings:UnnecessaryJavaDocLink @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Generate a hash code from the type, subtype and parameters.

Note that the equals(java.lang.Object) implementation does not perform a class equality check (this.getClass() == obj.getClass()). Therefore any class that extends from MediaType class and needs to override one of the equals(Object) and hashCode() methods must always override both methods to ensure the contract between Object#equals(java.lang.Object) and Object#hashCode() does not break.

Returns:int

a generated hash code.

Annotations

@SuppressWarnings:UnnecessaryJavaDocLink
@Override

isCompatible	back to summary
public boolean isCompatible(MediaType other) Check if this media type is compatible with another media type. E.g. image/* is compatible with image/jpeg, image/png, etc. Media type parameters are ignored. The function is commutative. Parameters other:MediaType the media type to compare with. Returns:boolean true if the types are compatible, false otherwise.

isCompatible

back to summary

public boolean isCompatible(MediaType other)

Check if this media type is compatible with another media type. E.g. image/* is compatible with image/jpeg, image/png, etc. Media type parameters are ignored. The function is commutative.

Parameters

other:MediaType: the media type to compare with.

Returns:boolean

true if the types are compatible, false otherwise.

isWildcardSubtype	back to summary
public boolean isWildcardSubtype() Checks if the subtype is a wildcard. Returns:boolean true if the subtype is a wildcard.

isWildcardSubtype

back to summary

public boolean isWildcardSubtype()

Checks if the subtype is a wildcard.

Returns:boolean: true if the subtype is a wildcard.

isWildcardType	back to summary
public boolean isWildcardType() Checks if the primary type is a wildcard. Returns:boolean true if the primary type is a wildcard.

isWildcardType

back to summary

public boolean isWildcardType()

Checks if the primary type is a wildcard.

Returns:boolean: true if the primary type is a wildcard.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Convert the media type to a string suitable for use as the value of a corresponding HTTP header.

Returns:String

a string version of the media type.

Annotations

@Override

valueOf back to summary

public static MediaType valueOf(String type)

Creates a new instance of MediaType by parsing the supplied string.

Parameters

type:String: the media type string.

Returns:MediaType

the newly created MediaType.

Exceptions

IllegalArgumentException:: if the supplied string cannot be parsed or is null.

withCharset back to summary

public MediaType withCharset(String charset)

Create a new MediaType instance with the same type, subtype and parameters copied from the original instance and the supplied charset parameter.

Parameters

charset:String: the charset parameter value. If null or empty the charset parameter will not be set or updated.

Returns:MediaType

copy of the current MediaType instance with the charset parameter set to the supplied value.

Since

2.0

public Class MediaType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail