org.glassfish.jersey.message.internal

Class QualitySourceMediaType

java.lang.Object

jakarta.ws.rs.core.MediaType

org.glassfish.jersey.message.internal.QualitySourceMediaType

All Implemented Interfaces:

Qualified

public class QualitySourceMediaType
extends MediaType
implements Qualified

A quality source media type.

Author:

Paul Sandoz, Marek Potociar

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<QualitySourceMediaType>	COMPARATOR Comparator for lists of quality source media types.

Fields inherited from class jakarta.ws.rs.core.MediaType

APPLICATION_ATOM_XML, APPLICATION_ATOM_XML_TYPE, APPLICATION_FORM_URLENCODED, APPLICATION_FORM_URLENCODED_TYPE, APPLICATION_JSON, APPLICATION_JSON_PATCH_JSON, APPLICATION_JSON_PATCH_JSON_TYPE, APPLICATION_JSON_TYPE, APPLICATION_OCTET_STREAM, APPLICATION_OCTET_STREAM_TYPE, APPLICATION_SVG_XML, APPLICATION_SVG_XML_TYPE, APPLICATION_XHTML_XML, APPLICATION_XHTML_XML_TYPE, APPLICATION_XML, APPLICATION_XML_TYPE, CHARSET_PARAMETER, MEDIA_TYPE_WILDCARD, MULTIPART_FORM_DATA, MULTIPART_FORM_DATA_TYPE, SERVER_SENT_EVENTS, SERVER_SENT_EVENTS_TYPE, TEXT_HTML, TEXT_HTML_TYPE, TEXT_PLAIN, TEXT_PLAIN_TYPE, TEXT_XML, TEXT_XML_TYPE, WILDCARD, WILDCARD_TYPE

Constructor Summary

Constructors

Constructor and Description
QualitySourceMediaType(String type, String subtype) Create new quality source media type instance with a default quality factor value.
QualitySourceMediaType(String type, String subtype, int quality, Map<String,String> parameters) Create new quality source media type instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares obj to this media type to see if they are the same by comparing type, subtype and parameters.
int	getQuality() Get quality source factor value (in [ppt]).
static int	getQualitySource(MediaType mediaType) Extract quality source information from the supplied MediaType value.
int	hashCode() Generate a hash code from the type, subtype and parameters.
String	toString() Convert the media type to a string suitable for use as the value of a corresponding HTTP header.
static QualitySourceMediaType	valueOf(HttpHeaderReader reader) Create new quality source media type instance from the supplied HTTP header reader.

Methods inherited from class jakarta.ws.rs.core.MediaType

getParameters, getSubtype, getType, isCompatible, isWildcardSubtype, isWildcardType, valueOf, withCharset

Methods inherited from class java.lang.Object

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

Field Detail

COMPARATOR

public static final Comparator<QualitySourceMediaType> COMPARATOR

Comparator for lists of quality source media types.

Constructor Detail

QualitySourceMediaType

public QualitySourceMediaType(String type,
                              String subtype)

Create new quality source media type instance with a default quality factor value.

Parameters:

type - the primary type, null is equivalent to MediaType.MEDIA_TYPE_WILDCARD

subtype - the subtype, null is equivalent to MediaType.MEDIA_TYPE_WILDCARD

QualitySourceMediaType

public QualitySourceMediaType(String type,
                              String subtype,
                              int quality,
                              Map<String,String> parameters)

Create new quality source media type instance.

Parameters:

type - the primary type, null is equivalent to MediaType.MEDIA_TYPE_WILDCARD

subtype - the subtype, null is equivalent to MediaType.MEDIA_TYPE_WILDCARD

quality - quality source factor value in [ppt]. See Qualified.

parameters - a map of media type parameters, null is the same as an empty map.

Method Detail

getQuality

public int getQuality()

Get quality source factor value (in [ppt]).

Specified by:

getQuality in interface Qualified

Returns:

quality source factor value.

valueOf

public static QualitySourceMediaType valueOf(HttpHeaderReader reader)
                                      throws ParseException

Create new quality source media type instance from the supplied HTTP header reader.

Parameters:

reader - HTTP header reader.

Returns:

new acceptable media type instance.

Throws:

ParseException - in case the input data parsing failed.

getQualitySource

public static int getQualitySource(MediaType mediaType)
                            throws IllegalArgumentException

Extract quality source information from the supplied MediaType value. If no quality source parameter is present in the media type, default quality is returned.

Parameters:

mediaType - media type.

Returns:

quality source parameter value or default quality, if no quality source parameter is present.

Throws:

IllegalArgumentException - in case the quality source parameter value could not be parsed.

equals

public boolean equals(Object obj)

Description copied from class: MediaType

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 HTTP/1.1. 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 MediaType.hashCode() methods must always override both methods to ensure the contract between Object.equals(java.lang.Object) and Object.hashCode() does not break.

Overrides:

equals in class MediaType

Parameters:

obj - the object to compare to.

Returns:

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

hashCode

public int hashCode()

Description copied from class: MediaType

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

Note that the MediaType.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 MediaType.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.

Overrides:

hashCode in class MediaType

Returns:

a generated hash code.

toString

public String toString()

Description copied from class: MediaType

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

Overrides:

toString in class MediaType

Returns:

a string version of the media type.