java.lang.Object
jakarta.ws.rs.core.MediaType
An abstraction for a media type. Instances are immutable.
- Since:
- 1.0
- Author:
- Paul Sandoz, Marc Hadley
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
AString
constant representing "application/atom+xml" media type.static final MediaType
AMediaType
constant representing "application/atom+xml" media type.static final String
AString
constant representing "application/x-www-form-urlencoded" media type.static final MediaType
AMediaType
constant representing "application/x-www-form-urlencoded" media type.static final String
AString
constant representing "application/json" media type.static final String
String
representation of "application/json-patch+json" media type..static final MediaType
AMediaType
constant representing "application/json-patch+json" media type.static final MediaType
AMediaType
constant representing "application/json" media type.static final String
AString
constant representing "application/octet-stream" media type.static final MediaType
AMediaType
constant representing "application/octet-stream" media type.static final String
AString
constant representing "application/svg+xml" media type.static final MediaType
AMediaType
constant representing "application/svg+xml" media type.static final String
AString
constant representing "application/xhtml+xml" media type.static final MediaType
AMediaType
constant representing "application/xhtml+xml" media type.static final String
AString
constant representing "application/xml" media type.static final MediaType
AMediaType
constant representing "application/xml" media type.static final String
The media typecharset
parameter name.static final String
The value of a type or subtype wildcard "*".static final String
AString
constant representing "multipart/form-data" media type.static final MediaType
AMediaType
constant representing "multipart/form-data" media type.static final String
String
representation of Server sent events media type.static final MediaType
Server sent events media type.static final String
AString
constant representing "text/html" media type.static final MediaType
AMediaType
constant representing "text/html" media type.static final String
AString
constant representing "text/plain" media type.static final MediaType
AMediaType
constant representing "text/plain" media type.static final String
AString
constant representing "text/xml" media type.static final MediaType
AMediaType
constant representing "text/xml" media type.static final String
AString
constant representing wildcard "*/*" media type .static final MediaType
-
Constructor Summary
ConstructorDescriptionCreates a new instance ofMediaType
, both type and subtype are wildcards.Creates a new instance ofMediaType
with the supplied type and subtype.Creates a new instance ofMediaType
with the supplied type, subtype and "charset" parameter.Creates a new instance ofMediaType
with the supplied type, subtype and parameters. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Comparesobj
to this media type to see if they are the same by comparing type, subtype and parameters.Getter for a read-only parameter map.Getter for subtype.getType()
Getter for primary type.int
hashCode()
Generate a hash code from the type, subtype and parameters.boolean
isCompatible
(MediaType other) Check if this media type is compatible with another media type.boolean
Checks if the subtype is a wildcard.boolean
Checks if the primary type is a wildcard.toString()
Convert the media type to a string suitable for use as the value of a corresponding HTTP header.static MediaType
Creates a new instance ofMediaType
by parsing the supplied string.withCharset
(String charset) Create a newMediaType
instance with the same type, subtype and parameters copied from the original instance and the supplied "charset" parameter.
-
Field Details
-
CHARSET_PARAMETER
The media typecharset
parameter name.- See Also:
-
MEDIA_TYPE_WILDCARD
The value of a type or subtype wildcard "*".- See Also:
-
WILDCARD
AString
constant representing wildcard "*/*" media type .- See Also:
-
WILDCARD_TYPE
-
APPLICATION_XML
AString
constant representing "application/xml" media type.- See Also:
-
APPLICATION_XML_TYPE
AMediaType
constant representing "application/xml" media type. -
APPLICATION_ATOM_XML
AString
constant representing "application/atom+xml" media type.- See Also:
-
APPLICATION_ATOM_XML_TYPE
AMediaType
constant representing "application/atom+xml" media type. -
APPLICATION_XHTML_XML
AString
constant representing "application/xhtml+xml" media type.- See Also:
-
APPLICATION_XHTML_XML_TYPE
AMediaType
constant representing "application/xhtml+xml" media type. -
APPLICATION_SVG_XML
AString
constant representing "application/svg+xml" media type.- See Also:
-
APPLICATION_SVG_XML_TYPE
AMediaType
constant representing "application/svg+xml" media type. -
APPLICATION_JSON
AString
constant representing "application/json" media type.- See Also:
-
APPLICATION_JSON_TYPE
AMediaType
constant representing "application/json" media type. -
APPLICATION_FORM_URLENCODED
AString
constant representing "application/x-www-form-urlencoded" media type.- See Also:
-
APPLICATION_FORM_URLENCODED_TYPE
AMediaType
constant representing "application/x-www-form-urlencoded" media type. -
MULTIPART_FORM_DATA
AString
constant representing "multipart/form-data" media type.- See Also:
-
MULTIPART_FORM_DATA_TYPE
AMediaType
constant representing "multipart/form-data" media type. -
APPLICATION_OCTET_STREAM
AString
constant representing "application/octet-stream" media type.- See Also:
-
APPLICATION_OCTET_STREAM_TYPE
AMediaType
constant representing "application/octet-stream" media type. -
TEXT_PLAIN
AString
constant representing "text/plain" media type.- See Also:
-
TEXT_PLAIN_TYPE
AMediaType
constant representing "text/plain" media type. -
TEXT_XML
AString
constant representing "text/xml" media type.- See Also:
-
TEXT_XML_TYPE
AMediaType
constant representing "text/xml" media type. -
TEXT_HTML
AString
constant representing "text/html" media type.- See Also:
-
TEXT_HTML_TYPE
AMediaType
constant representing "text/html" media type. -
SERVER_SENT_EVENTS
String
representation of Server sent events media type. (""text/event-stream"").- See Also:
-
SERVER_SENT_EVENTS_TYPE
Server sent events media type. -
APPLICATION_JSON_PATCH_JSON
String
representation of "application/json-patch+json" media type..- See Also:
-
APPLICATION_JSON_PATCH_JSON_TYPE
AMediaType
constant representing "application/json-patch+json" media type.
-
-
Constructor Details
-
MediaType
Creates a new instance ofMediaType
with the supplied type, subtype and parameters.- Parameters:
type
- the primary type,null
is equivalent toMEDIA_TYPE_WILDCARD
.subtype
- the subtype,null
is equivalent toMEDIA_TYPE_WILDCARD
.parameters
- a map of media type parameters,null
is the same as an empty map.
-
MediaType
Creates a new instance ofMediaType
with the supplied type and subtype.- Parameters:
type
- the primary type,null
is equivalent toMEDIA_TYPE_WILDCARD
subtype
- the subtype,null
is equivalent toMEDIA_TYPE_WILDCARD
-
MediaType
Creates a new instance ofMediaType
with the supplied type, subtype and "charset" parameter.- Parameters:
type
- the primary type,null
is equivalent toMEDIA_TYPE_WILDCARD
subtype
- the subtype,null
is equivalent toMEDIA_TYPE_WILDCARD
charset
- the "charset" parameter value. Ifnull
or empty the "charset" parameter will not be set.
-
MediaType
public MediaType()Creates a new instance ofMediaType
, both type and subtype are wildcards. Consider using the constantWILDCARD_TYPE
instead.
-
-
Method Details
-
valueOf
Creates a new instance ofMediaType
by parsing the supplied string.- Parameters:
type
- the media type string.- Returns:
- the newly created MediaType.
- Throws:
IllegalArgumentException
- if the supplied string cannot be parsed or isnull
.
-
getType
Getter for primary type.- Returns:
- value of primary type.
-
isWildcardType
public boolean isWildcardType()Checks if the primary type is a wildcard.- Returns:
- true if the primary type is a wildcard.
-
getSubtype
Getter for subtype.- Returns:
- value of subtype.
-
isWildcardSubtype
public boolean isWildcardSubtype()Checks if the subtype is a wildcard.- Returns:
- true if the subtype is a wildcard.
-
getParameters
Getter for a read-only parameter map. Keys are case-insensitive.- Returns:
- an immutable map of parameters.
-
withCharset
Create a newMediaType
instance with the same type, subtype and parameters copied from the original instance and the supplied "charset" parameter. -
isCompatible
Check if this media type is compatible with another media type. Two media types are considered to be compatible if and only if their types are equal, or one of them has a wildcard type, and their subtypes are equal or one of them has a wildcard subtype. Media type parameters are ignored. The function is commutative.- Parameters:
other
- the media type to compare with.- Returns:
- true if the types are compatible, false otherwise.
-
equals
Compares
Note that theobj
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 HTTP/1.1. This method assumes that values are case-sensitive.equals(...)
implementation does not perform a class equality check (this.getClass() == obj.getClass()
). Therefore any class that extends fromMediaType
class and needs to override one of theequals(...)
andhashCode()
methods must always override both methods to ensure the contract betweenObject.equals(java.lang.Object)
andObject.hashCode()
does not break. -
hashCode
public int hashCode()Generate a hash code from the type, subtype and parameters.
Note that theequals(java.lang.Object)
implementation does not perform a class equality check (this.getClass() == obj.getClass()
). Therefore any class that extends fromMediaType
class and needs to override one of theequals(Object)
andhashCode()
methods must always override both methods to ensure the contract betweenObject.equals(java.lang.Object)
andObject.hashCode()
does not break. -
toString
Convert the media type to a string suitable for use as the value of a corresponding HTTP header.
-