Package org.apache.juneau.http.header

Class BasicStringRangesHeader

java.lang.Object

org.apache.juneau.http.header.BasicHeader

org.apache.juneau.http.header.BasicStringRangesHeader

All Implemented Interfaces:

Serializable, Cloneable, Header, NameValuePair

Direct Known Subclasses:

AcceptCharset, AcceptEncoding, AcceptLanguage, ContentDisposition, TE

public class BasicStringRangesHeader
extends BasicHeader

Category of headers that consist of simple comma-delimited lists of strings with q-values.

Example

Accept-Encoding: compress;q=0.5, gzip;q=1.0

See Also:

• juneau-rest-common
• Hypertext Transfer Protocol -- HTTP/1.1

Constructor Summary

Constructors

Constructor	Description
BasicStringRangesHeader(String name, String value)	Constructor.
BasicStringRangesHeader(String name, Supplier<StringRanges> value)	Constructor with delayed value.
BasicStringRangesHeader(String name, StringRanges value)	Constructor.

Method Summary

Modifier and Type	Method	Description
Optional<StringRanges>	asStringRanges()	Returns the header value as a StringRanges wrapped in an Optional.
StringRange	getRange(int index)	Returns the MediaRange at the specified index.
String	getValue()
int	match(List<String> names)	Given a list of media types, returns the best match for this string range header.
static BasicStringRangesHeader	of(String name, String value)	Static creator.
static BasicStringRangesHeader	of(String name, Supplier<StringRanges> value)	Static creator with delayed value.
static BasicStringRangesHeader	of(String name, StringRanges value)	Static creator.
StringRanges	orElse(StringRanges other)	Return the value if present, otherwise return other.
StringRanges	toStringRanges()	Returns the header value as a StringRanges.

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

assertName, assertStringValue, asString, equals, equalsIgnoreCase, get, getElements, getName, hashCode, isNotEmpty, isPresent, of, of, orElse, toString

Methods inherited from class java.lang.Object

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

Constructor Details

BasicStringRangesHeader

public BasicStringRangesHeader(String name,
 String value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Must be parsable by StringRanges.of(String).
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicStringRangesHeader

public BasicStringRangesHeader(String name,
 StringRanges value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicStringRangesHeader

public BasicStringRangesHeader(String name,
 Supplier<StringRanges> value)

Constructor with delayed value.

Header value is re-evaluated on each call to getValue().

Parameters:

name - The header name.

value - The supplier of the header value.
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

Method Details

of

public static BasicStringRangesHeader of(String name,
 String value)

Static creator.

Parameters:

name - The header name.

value - The header value.
Must be parsable by StringRanges.of(String).
Can be null.

Returns:

A new header bean, or null if the value is null.

Throws:

IllegalArgumentException - If name is null or empty.

of

public static BasicStringRangesHeader of(String name,
 StringRanges value)

Static creator.

Parameters:

name - The header name.

value - The header value.
Can be null.

Returns:

A new header bean, or null if the value is null.

Throws:

IllegalArgumentException - If name is null or empty.

of

public static BasicStringRangesHeader of(String name,
 Supplier<StringRanges> value)

Static creator with delayed value.

Header value is re-evaluated on each call to getValue().

Parameters:

name - The header name.

value - The supplier of the header value.
Can be null.

Returns:

A new header bean, or null if the value is null.

Throws:

IllegalArgumentException - If name is null or empty.

getValue

public String getValue()

Specified by:

getValue in interface NameValuePair

Overrides:

getValue in class BasicHeader

asStringRanges

public Optional<StringRanges> asStringRanges()

Returns the header value as a StringRanges wrapped in an Optional.

Returns:

The header value as a StringRanges wrapped in an Optional. Never null.

toStringRanges

public StringRanges toStringRanges()

Returns the header value as a StringRanges.

Returns:

The header value as a StringRanges. Can be null.

match

public int match(List<String> names)

Given a list of media types, returns the best match for this string range header.

Note that fuzzy matching is allowed on the media types where the string range header may contain additional subtype parts.
For example, given identical q-values and an string range value of "text/json+activity", the media type "text/json" will match if "text/json+activity" or "text/activity+json" isn't found.
The purpose for this is to allow serializers to match when artifacts such as id properties are present in the header.

See ActivityPub / Retrieving Objects

Parameters:

names - The names to match against.

Returns:

The index into the array of the best match, or -1 if no suitable matches could be found.

getRange

public StringRange getRange(int index)

Returns the MediaRange at the specified index.

Parameters:

index - The index position of the media range.

Returns:

The MediaRange at the specified index or null if the index is out of range.

orElse

public StringRanges orElse(StringRanges other)

Return the value if present, otherwise return other.

This is a shortened form for calling asArray().orElse(other).

Parameters:

other - The value to be returned if there is no value present, can be null.

Returns:

The value, if present, otherwise other.