Package org.apache.juneau.http.header

Class HttpMediaRangesHeader

java.lang.Object

org.apache.juneau.http.header.HttpHeaderBean

org.apache.juneau.http.header.HttpMediaRangesHeader

All Implemented Interfaces:

HttpHeader

Direct Known Subclasses:

Accept

public class HttpMediaRangesHeader
extends HttpHeaderBean

Base type for headers whose wire format is an Accept-style list of media ranges.

See Also:

• Next-Generation REST Client

Since:

9.2.1

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LAZY_MEDIA_RANGES	Lazy supplier provides MediaRanges (re-evaluated on each access).
static final int	LAZY_WIRE_STRING	Lazy supplier provides the wire string.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpMediaRangesHeader(String name, String value)
protected	HttpMediaRangesHeader(String name, Supplier<?> supplier, int lazyMode)
protected	HttpMediaRangesHeader(String name, MediaRanges value)

Method Summary

Modifier and Type	Method	Description
Optional<MediaRanges>	asMediaRanges()
MediaRange	getRange(int index)
boolean	hasSubtypePart(String part)
int	match(List<? extends MediaType> mediaTypes)
MediaRanges	orElse(MediaRanges other)
MediaRanges	toMediaRanges()

Methods inherited from class org.apache.juneau.http.header.HttpHeaderBean

equals, equalsIgnoreCase, getName, getValue, hashCode, of, of, toString

Methods inherited from class java.lang.Object

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

Field Details

LAZY_WIRE_STRING

public static final int LAZY_WIRE_STRING

Lazy supplier provides the wire string.

See Also:

• Constant Field Values

LAZY_MEDIA_RANGES

public static final int LAZY_MEDIA_RANGES

Lazy supplier provides MediaRanges (re-evaluated on each access).

See Also:

• Constant Field Values

Constructor Details

HttpMediaRangesHeader

protected HttpMediaRangesHeader(String name,
 String value)

Parameters:

name - Header name. Must not be null.

value - Wire value. May be null.

HttpMediaRangesHeader

protected HttpMediaRangesHeader(String name,
 MediaRanges value)

Parameters:

name - Header name. Must not be null.

value - Parsed media ranges. May be null.

HttpMediaRangesHeader

protected HttpMediaRangesHeader(String name,
 Supplier<?> supplier,
 int lazyMode)

Parameters:

name - Header name. Must not be null.

supplier - Lazy supplier; mode LAZY_WIRE_STRING or LAZY_MEDIA_RANGES. Must not be null.

lazyMode - Discriminator for erasure-safe lazy construction.

Method Details

asMediaRanges

public Optional<MediaRanges> asMediaRanges()

Returns:

Parsed MediaRanges, or an empty Optional if the wire value is absent.

getRange

public MediaRange getRange(int index)

Parameters:

index - Range index.

Returns:

The MediaRange at index, or null if out of range.

hasSubtypePart

public boolean hasSubtypePart(String part)

Parameters:

part - Subtype fragment to find (e.g. "activity" for text/json+activity).

Returns:

true if any range's subtype contains the fragment.

match

public int match(List<? extends MediaType> mediaTypes)

Parameters:

mediaTypes - Candidate types, in preference order.

Returns:

Index of the best matching type, or -1.

orElse

public MediaRanges orElse(MediaRanges other)

Parameters:

other - Fallback when no parsed value is present.

Returns:

Parsed ranges or other.

toMediaRanges

public MediaRanges toMediaRanges()

Returns:

Parsed MediaRanges, or null if the wire value is absent.