org.everrest.core.impl.header

Class MediaTypeHelper

java.lang.Object

org.everrest.core.impl.header.MediaTypeHelper

public final class MediaTypeHelper
extends Object

Version:

$Id$

Author:

Andrey Parfonov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaTypeHelper.MediaTypeRange Builder or range acceptable media types for look up appropriate MessageBodyReader, MessageBodyWriter or ContextResolver.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT Default media type.
static javax.ws.rs.core.MediaType	DEFAULT_TYPE Default media type.
static List<javax.ws.rs.core.MediaType>	DEFAULT_TYPE_LIST List which contains default media type.
static String	EXT_PREFIX_SUBTYPE Prefix of sub-type part of media types as application/*+xml.
static Pattern	EXT_PREFIX_SUBTYPE_PATTERN Media types as application/*+xml pattern.
static Pattern	EXT_SUBTYPE_PATTERN Media types as application/atom+* or application/*+xml pattern.
static String	EXT_SUFFIX_SUBTYPE Suffix of sub-type part of media types as application/atom+*.
static Pattern	EXT_SUFFIX_SUBTYPE_PATTERN Media types as application/atom+* pattern.
static Comparator<javax.ws.rs.core.MediaType>	MEDIA_TYPE_COMPARATOR Compare two mime-types.
static String	WADL WADL media type.
static javax.ws.rs.core.MediaType	WADL_TYPE WADL media type.

Method Summary

Modifier and Type	Method and Description
static List<javax.ws.rs.core.MediaType>	createConsumesList(javax.ws.rs.Consumes mime) Create a list of media type for given Consumes annotation.
static List<javax.ws.rs.core.MediaType>	createProducesList(javax.ws.rs.Produces mime) Create a list of media type for given Produces annotation.
static boolean	isCompatible(javax.ws.rs.core.MediaType one, javax.ws.rs.core.MediaType two) Check types one and type two are compatible.
static boolean	isConsume(List<javax.ws.rs.core.MediaType> consumes, javax.ws.rs.core.MediaType contentType) Useful for checking does method able to consume certain media type.
static boolean	isMatched(javax.ws.rs.core.MediaType pattern, javax.ws.rs.core.MediaType checkMe) Check is type checkMe matched to type pattern.
static float	processQuality(List<javax.ws.rs.core.MediaType> accept, List<javax.ws.rs.core.MediaType> produces) Looking for accept media type with the best quality.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final String DEFAULT

Default media type. It minds any content type.

See Also:

Constant Field Values

DEFAULT_TYPE

public static final javax.ws.rs.core.MediaType DEFAULT_TYPE

Default media type. It minds any content type.

DEFAULT_TYPE_LIST

public static final List<javax.ws.rs.core.MediaType> DEFAULT_TYPE_LIST

List which contains default media type.

WADL

public static final String WADL

WADL media type.

See Also:

Constant Field Values

WADL_TYPE

public static final javax.ws.rs.core.MediaType WADL_TYPE

WADL media type.

EXT_SUFFIX_SUBTYPE

public static final String EXT_SUFFIX_SUBTYPE

Suffix of sub-type part of media types as application/atom+*.

See Also:

Constant Field Values

EXT_PREFIX_SUBTYPE

public static final String EXT_PREFIX_SUBTYPE

Prefix of sub-type part of media types as application/*+xml.

See Also:

Constant Field Values

EXT_SUBTYPE_PATTERN

public static final Pattern EXT_SUBTYPE_PATTERN

Media types as application/atom+* or application/*+xml pattern.

EXT_SUFFIX_SUBTYPE_PATTERN

public static final Pattern EXT_SUFFIX_SUBTYPE_PATTERN

Media types as application/atom+* pattern.

EXT_PREFIX_SUBTYPE_PATTERN

public static final Pattern EXT_PREFIX_SUBTYPE_PATTERN

Media types as application/*+xml pattern.

MEDIA_TYPE_COMPARATOR

public static final Comparator<javax.ws.rs.core.MediaType> MEDIA_TYPE_COMPARATOR

Compare two mime-types. The main rule for sorting media types is :

n / m n / * * / *

Method that explicitly list of media types is sorted before a method that list * / *.

Method Detail

createConsumesList

public static List<javax.ws.rs.core.MediaType> createConsumesList(javax.ws.rs.Consumes mime)

Create a list of media type for given Consumes annotation. If parameter mime is null then list with single element DEFAULT_TYPE will be returned.

Parameters:

mime - the Consumes annotation.

Returns:

ordered list of media types.

createProducesList

public static List<javax.ws.rs.core.MediaType> createProducesList(javax.ws.rs.Produces mime)

Create a list of media type for given Produces annotation. If parameter mime is null then list with single element DEFAULT_TYPE will be returned.

Parameters:

mime - the Produces annotation.

Returns:

ordered list of media types.

isConsume

public static boolean isConsume(List<javax.ws.rs.core.MediaType> consumes,
                                javax.ws.rs.core.MediaType contentType)

Useful for checking does method able to consume certain media type.

Parameters:

consumes - list of consumed media types

contentType - should be checked

Returns:

true contentType is compatible to one of consumes, false otherwise

processQuality

public static float processQuality(List<javax.ws.rs.core.MediaType> accept,
                                   List<javax.ws.rs.core.MediaType> produces)

Looking for accept media type with the best quality. Accept list of media type must be sorted by quality value.

Parameters:

accept - See AcceptMediaType, QualityValue

produces - list of produces media type, See Produces

Returns:

quality value of best found compatible accept media type or 0.0 if media types are not compatible

isCompatible

public static boolean isCompatible(javax.ws.rs.core.MediaType one,
                                   javax.ws.rs.core.MediaType two)

Check types one and type two are compatible. The operation is commutative.

Examples:

• text/plain and text/* are compatible
• application/atom+xml and application/atom+* are compatible

Parameters:

one - media type

two - media type

Returns:

true if types compatible and false otherwise

isMatched

public static boolean isMatched(javax.ws.rs.core.MediaType pattern,
                                javax.ws.rs.core.MediaType checkMe)

Check is type checkMe matched to type pattern. NOTE The operation is NOT commutative, e.g. matching of type checkMe matched to pattern does not guaranty that pattern matched to checkMe.

Examples:

• text/plain is matched to text/* but type text/* is not matched to text/plain
• application/atom+xml is matched to application/atom+* but type application/atom+* is not matched to application/atom+xml

Parameters:

pattern - pattern type

checkMe - type to be checked

Returns:

true if type checkMe is matched to pattern and false otherwise