Package org.apache.juneau.http.header

Class BasicBooleanHeader

java.lang.Object

org.apache.juneau.http.header.BasicHeader

org.apache.juneau.http.header.BasicBooleanHeader

All Implemented Interfaces:

Serializable, Cloneable, Header, NameValuePair

Direct Known Subclasses:

Debug, NoTrace

@Header
@Schema(type="boolean")
public class BasicBooleanHeader
extends BasicHeader

Category of headers that consist of a single boolean value.

Example

Foo: true

See Also:

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

Constructor Summary

Constructors

Constructor	Description
BasicBooleanHeader(String name, Boolean value)	Constructor.
BasicBooleanHeader(String name, String value)	Constructor.
BasicBooleanHeader(String name, Supplier<Boolean> value)	Constructor with delayed value.

Method Summary

Modifier and Type	Method	Description
Optional<Boolean>	asBoolean()	Returns the header value as a Boolean wrapped in an Optional.
FluentBooleanAssertion<BasicBooleanHeader>	assertBoolean()	Provides the ability to perform fluent-style assertions on this header.
String	getValue()
boolean	isTrue()	Returns true if the header value is true.
static BasicBooleanHeader	of(String name, Boolean value)	Static creator.
static BasicBooleanHeader	of(String name, String value)	Static creator.
static BasicBooleanHeader	of(String name, Supplier<Boolean> value)	Static creator with delayed value.
Boolean	orElse(Boolean other)	Return the value if present, otherwise return other.
Boolean	toBoolean()	Returns the header value as a Boolean.

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

BasicBooleanHeader

public BasicBooleanHeader(String name,
 String value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Must be parsable by Boolean.parseBoolean(String).
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicBooleanHeader

public BasicBooleanHeader(String name,
 Boolean value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicBooleanHeader

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

Static creator.

Parameters:

name - The header name.

value - The header value.
Must be parsable by Boolean.parseBoolean(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 BasicBooleanHeader of(String name,
 Boolean 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 BasicBooleanHeader of(String name,
 Supplier<Boolean> 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

asBoolean

public Optional<Boolean> asBoolean()

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

Returns:

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

toBoolean

public Boolean toBoolean()

Returns the header value as a Boolean.

Returns:

The header value as a Boolean. Can be null.

isTrue

public boolean isTrue()

Returns true if the header value is true.

Returns:

true if the header value is true.

assertBoolean

public FluentBooleanAssertion<BasicBooleanHeader> assertBoolean()

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

Examples:

// Validates the response header Foo is true. client .get(URL) .run() .getHeader("Foo").asBooleanHeader().assertBoolean().isTrue();

Returns:

A new fluent assertion object.

Throws:

AssertionError - If assertion failed.

orElse

public Boolean orElse(Boolean other)

Return the value if present, otherwise return other.

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