Package org.apache.juneau.http.header

Class BasicEntityTagHeader

java.lang.Object

org.apache.juneau.http.header.BasicHeader

org.apache.juneau.http.header.BasicEntityTagHeader

All Implemented Interfaces:

Serializable, Cloneable, Header, NameValuePair

Direct Known Subclasses:

ETag

public class BasicEntityTagHeader
extends BasicHeader

Category of headers that consist of a single entity validator value.

Example

ETag: "xyzzy" ETag: W/"xyzzy" ETag: ""

See Also:

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

Constructor Summary

Constructors

Constructor	Description
BasicEntityTagHeader(String name, String value)	Constructor.
BasicEntityTagHeader(String name, Supplier<EntityTag> value)	Constructor with delayed value.
BasicEntityTagHeader(String name, EntityTag value)	Constructor.

Method Summary

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

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

BasicEntityTagHeader

public BasicEntityTagHeader(String name,
 String value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Must be an entity tag value (e.g. "\"xyzzy\"").
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicEntityTagHeader

public BasicEntityTagHeader(String name,
 EntityTag value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicEntityTagHeader

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

Static creator.

Parameters:

name - The header name.

value - The header value.
Must be an entity tag value (e.g. "\"xyzzy\"").
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 BasicEntityTagHeader of(String name,
 EntityTag 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 BasicEntityTagHeader of(String name,
 Supplier<EntityTag> 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

asEntityTag

public Optional<EntityTag> asEntityTag()

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

Returns:

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

toEntityTag

public EntityTag toEntityTag()

Returns the header value as an EntityTag.

Returns:

The header value as an EntityTag. Can be null.

orElse

public EntityTag orElse(EntityTag other)

Return the value if present, otherwise return other.

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