Package org.apache.juneau.http.header

Class BasicEntityTagsHeader

java.lang.Object

org.apache.juneau.http.header.BasicHeader

org.apache.juneau.http.header.BasicEntityTagsHeader

All Implemented Interfaces:

Serializable, Cloneable, Header, NameValuePair

Direct Known Subclasses:

IfMatch, IfNoneMatch

public class BasicEntityTagsHeader
extends BasicHeader

Category of headers that consist of a comma-delimited list of entity validator values.

Example

If-Match: "xyzzy" If-Match: "xyzzy", "r2d2xxxx", "c3piozzzz" If-Match: *

See Also:

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

Constructor Summary

Constructors

Constructor	Description
BasicEntityTagsHeader(String name, String value)	Constructor.
BasicEntityTagsHeader(String name, Supplier<EntityTags> value)	Constructor with delayed value.
BasicEntityTagsHeader(String name, EntityTags value)	Constructor.

Method Summary

Modifier and Type	Method	Description
Optional<EntityTags>	asEntityTags()	Returns the header value as an EntityTags wrapped in an Optional.
String	getValue()
static BasicEntityTagsHeader	of(String name, String value)	Static creator.
static BasicEntityTagsHeader	of(String name, Supplier<EntityTags> value)	Static creator with delayed value.
static BasicEntityTagsHeader	of(String name, EntityTags value)	Static creator.
EntityTags	orElse(EntityTags other)	Return the value if present, otherwise return other.
EntityTags	toEntityTags()	Returns the header value as an EntityTags wrapped in an Optional.

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

BasicEntityTagsHeader

public BasicEntityTagsHeader(String name,
 String value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Must be a comma-delimited list of entity validator values (e.g. "\"xyzzy\", \"r2d2xxxx\", \"c3piozzzz\"").
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicEntityTagsHeader

public BasicEntityTagsHeader(String name,
 EntityTags value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicEntityTagsHeader

public BasicEntityTagsHeader(String name,
 Supplier<EntityTags> 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 BasicEntityTagsHeader of(String name,
 String value)

Static creator.

Parameters:

name - The header name.

value - The header value.
Must be a comma-delimited list of entity validator values (e.g. "\"xyzzy\", \"r2d2xxxx\", \"c3piozzzz\"").
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 BasicEntityTagsHeader of(String name,
 EntityTags 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 BasicEntityTagsHeader of(String name,
 Supplier<EntityTags> 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

asEntityTags

public Optional<EntityTags> asEntityTags()

Returns the header value as an EntityTags wrapped in an Optional.

Returns:

The header value as an EntityTags wrapped in an Optional. Never null.

toEntityTags

public EntityTags toEntityTags()

Returns the header value as an EntityTags wrapped in an Optional.

Returns:

The header value as an EntityTags wrapped in an Optional. Never null.

orElse

public EntityTags orElse(EntityTags other)

Return the value if present, otherwise return other.

This is a shortened form for calling asEntityTags().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.