com.linecorp.armeria.common

Class MediaTypeSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<MediaType>

com.linecorp.armeria.common.MediaTypeSet

All Implemented Interfaces:

Iterable<MediaType>, Collection<MediaType>, Set<MediaType>

public final class MediaTypeSet
extends AbstractSet<MediaType>

An immutable Set of MediaTypes which provides useful methods for content negotiation.

This Set provides match(MediaType) and matchHeaders(CharSequence...) so that a user can find the preferred MediaType that matches the specified media ranges. For example:

 MediaTypeSet set = new MediaTypeSet(MediaType.HTML_UTF_8, MediaType.PLAIN_TEXT_UTF_8);

 MediaType negotiated1 = set.matchHeaders("text/html; q=0.5, text/plain");
 assert negotiated1 != null;
 assert negotiated1.equals(MediaType.PLAIN_TEXT_UTF_8);

 MediaType negotiated2 = set.matchHeaders("audio/*, text/*");
 assert negotiated2 != null;
 assert negotiated2.equals(MediaType.HTML_UTF_8);

 MediaType negotiated3 = set.matchHeaders("video/webm");
 assert negotiated3 == null;
 

Constructor Summary

Constructors

Constructor and Description
MediaTypeSet(Iterable<MediaType> mediaTypes) Deprecated. Use of(Iterable).
MediaTypeSet(MediaType... mediaTypes) Deprecated. Use of(MediaType...).

Method Summary

Modifier and Type	Method and Description
boolean	contains(Object o)
Iterator<MediaType>	iterator()
MediaType	match(Iterable<MediaType> ranges) Finds the MediaType in this List that matches one of the specified media ranges.
MediaType	match(MediaType range) Finds the MediaType in this List that matches the specified media range.
MediaType	match(MediaType first, MediaType... rest) Finds the MediaType in this List that matches one of the specified media ranges.
MediaType	matchHeaders(CharSequence... acceptHeaders) Finds the MediaType in this List that matches one of the media ranges specified in the specified string.
MediaType	matchHeaders(Iterable<? extends CharSequence> acceptHeaders) Finds the MediaType in this List that matches one of the media ranges specified in the specified string.
static MediaTypeSet	of(Iterable<MediaType> mediaTypes) Returns the MediaTypeSet which is composed of the specified MediaTypes.
static MediaTypeSet	of(MediaType... mediaTypes) Returns the MediaTypeSet which is composed of the specified MediaTypes.
int	size()

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

add, addAll, clear, containsAll, isEmpty, remove, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

add, addAll, clear, containsAll, isEmpty, remove, retainAll, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

MediaTypeSet

@Deprecated
public MediaTypeSet(MediaType... mediaTypes)

Deprecated. Use of(MediaType...).

Creates a new instance.

MediaTypeSet

@Deprecated
public MediaTypeSet(Iterable<MediaType> mediaTypes)

Deprecated. Use of(Iterable).

Creates a new instance.

Method Detail

of

public static MediaTypeSet of(MediaType... mediaTypes)

Returns the MediaTypeSet which is composed of the specified MediaTypes.

of

public static MediaTypeSet of(Iterable<MediaType> mediaTypes)

Returns the MediaTypeSet which is composed of the specified MediaTypes.

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<MediaType>

Specified by:

contains in interface Set<MediaType>

Overrides:

contains in class AbstractCollection<MediaType>

iterator

public Iterator<MediaType> iterator()

Specified by:

iterator in interface Iterable<MediaType>

Specified by:

iterator in interface Collection<MediaType>

Specified by:

iterator in interface Set<MediaType>

Specified by:

iterator in class AbstractCollection<MediaType>

size

public int size()

Specified by:

size in interface Collection<MediaType>

Specified by:

size in interface Set<MediaType>

Specified by:

size in class AbstractCollection<MediaType>

matchHeaders

public MediaType matchHeaders(Iterable<? extends CharSequence> acceptHeaders)

Finds the MediaType in this List that matches one of the media ranges specified in the specified string.

Parameters:

acceptHeaders - the values of the "accept" header, as defined in the section 14.1, RFC2616

Returns:

the most preferred MediaType that matches one of the specified media ranges. null if there are no matches or acceptHeaders does not contain any valid ranges.

matchHeaders

public MediaType matchHeaders(CharSequence... acceptHeaders)

Finds the MediaType in this List that matches one of the media ranges specified in the specified string.

Parameters:

acceptHeaders - the values of the "accept" header, as defined in the section 14.1, RFC2616

Returns:

the most preferred MediaType that matches one of the specified media ranges. null if there are no matches or acceptHeaders does not contain any valid ranges.

match

public MediaType match(MediaType range)

Finds the MediaType in this List that matches the specified media range.

Returns:

the MediaType that matches the specified media range. null if there are no matches

match

public MediaType match(MediaType first,
                       MediaType... rest)

Finds the MediaType in this List that matches one of the specified media ranges.

Returns:

the most preferred MediaType that matches one of the specified media ranges. null if there are no matches or the specified ranges do not contain any valid ranges.

match

public MediaType match(Iterable<MediaType> ranges)

Finds the MediaType in this List that matches one of the specified media ranges.

Returns:

the most preferred MediaType that matches one of the specified media ranges. null if there are no matches or ranges does not contain any valid ranges.