Package org.apache.juneau.http.header

Class BasicDateHeader

java.lang.Object

org.apache.juneau.http.header.BasicHeader

org.apache.juneau.http.header.BasicDateHeader

All Implemented Interfaces:

Serializable, Cloneable, Header, NameValuePair

Direct Known Subclasses:

Date, Expires, IfModifiedSince, IfRange, IfUnmodifiedSince, LastModified, RetryAfter

public class BasicDateHeader
extends BasicHeader

Category of headers that consist of a single HTTP-date.

Example

If-Modified-Since: Sat, 29 Oct 1994 19:43:31 GMT

See Also:

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

Constructor Summary

Constructors

Constructor	Description
BasicDateHeader(String name, String value)	Constructor.
BasicDateHeader(String name, ZonedDateTime value)	Constructor.
BasicDateHeader(String name, Supplier<ZonedDateTime> value)	Constructor with delayed value.

Method Summary

Modifier and Type	Method	Description
FluentZonedDateTimeAssertion<BasicDateHeader>	assertZonedDateTime()	Provides the ability to perform fluent-style assertions on this header.
Optional<ZonedDateTime>	asZonedDateTime()	Returns the header value as a ZonedDateTime wrapped in an Optional.
String	getValue()
static BasicDateHeader	of(String name, String value)	Static creator.
static BasicDateHeader	of(String name, ZonedDateTime value)	Static creator.
static BasicDateHeader	of(String name, Supplier<ZonedDateTime> value)	Static creator with delayed value.
ZonedDateTime	orElse(ZonedDateTime other)	Return the value if present, otherwise return other.
ZonedDateTime	toZonedDateTime()	Returns the header value as a ZonedDateTime.

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

BasicDateHeader

public BasicDateHeader(String name,
 String value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Must be an RFC-1123 formated string (e.g. "Sat, 29 Oct 1994 19:43:31 GMT").
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicDateHeader

public BasicDateHeader(String name,
 ZonedDateTime value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicDateHeader

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

Static creator.

Parameters:

name - The header name.

value - The header value.
Must be an RFC-1123 formated string (e.g. "Sat, 29 Oct 1994 19:43:31 GMT").
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 BasicDateHeader of(String name,
 ZonedDateTime 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 BasicDateHeader of(String name,
 Supplier<ZonedDateTime> 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

asZonedDateTime

public Optional<ZonedDateTime> asZonedDateTime()

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

Returns:

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

toZonedDateTime

public ZonedDateTime toZonedDateTime()

Returns the header value as a ZonedDateTime.

Returns:

The header value as a ZonedDateTime. Can be null.

assertZonedDateTime

public FluentZonedDateTimeAssertion<BasicDateHeader> assertZonedDateTime()

Provides the ability to perform fluent-style assertions on this header.

Examples:

// Validates the response body content is not expired. client .get(URL) .run() .getHeader("Expires").asDateHeader().assertZonedDateTime().isLessThan(new Date());

Returns:

A new fluent assertion object.

Throws:

AssertionError - If assertion failed.

orElse

public ZonedDateTime orElse(ZonedDateTime other)

Return the value if present, otherwise return other.

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