Package org.apache.juneau.http.header

Class BasicIntegerHeader

java.lang.Object

org.apache.juneau.http.header.BasicHeader

org.apache.juneau.http.header.BasicIntegerHeader

All Implemented Interfaces:

Serializable, Cloneable, Header, NameValuePair

Direct Known Subclasses:

Age, MaxForwards

@Header
@Schema(type="integer",
        format="int32")
public class BasicIntegerHeader
extends BasicHeader

Category of headers that consist of a single integer value.

Example

Age: 300

See Also:

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

Constructor Summary

Constructors

Constructor	Description
BasicIntegerHeader(String name, Integer value)	Constructor.
BasicIntegerHeader(String name, String value)	Constructor.
BasicIntegerHeader(String name, Supplier<Integer> value)	Constructor with delayed value.

Method Summary

Modifier and Type	Method	Description
Optional<Integer>	asInteger()	Returns the header value as an Integer wrapped in an Optional.
FluentIntegerAssertion<BasicIntegerHeader>	assertInteger()	Provides the ability to perform fluent-style assertions on this header.
String	getValue()
static BasicIntegerHeader	of(String name, Integer value)	Static creator.
static BasicIntegerHeader	of(String name, String value)	Static creator.
static BasicIntegerHeader	of(String name, Supplier<Integer> value)	Static creator with delayed value.
Integer	orElse(Integer other)	Return the value if present, otherwise return other.
Integer	toInteger()	Returns the header value as an Integer.

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

BasicIntegerHeader

public BasicIntegerHeader(String name,
 String value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Must be parsable using Integer.parseInt(String).
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicIntegerHeader

public BasicIntegerHeader(String name,
 Integer value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicIntegerHeader

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

Static creator.

Parameters:

name - The header name.

value - The header value.
Must be parsable using Integer.parseInt(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 BasicIntegerHeader of(String name,
 Integer 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 BasicIntegerHeader of(String name,
 Supplier<Integer> 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

asInteger

public Optional<Integer> asInteger()

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

Returns:

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

toInteger

public Integer toInteger()

Returns the header value as an Integer.

Returns:

The header value as an Integer. Can be null.

assertInteger

public FluentIntegerAssertion<BasicIntegerHeader> assertInteger()

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

Examples:

// Validates the response content is older than 1. client .get(URL) .run() .getHeader("Age").asIntegerHeader().assertInteger().isGreaterThan(1);

Returns:

A new fluent assertion object.

Throws:

AssertionError - If assertion failed.

orElse

public Integer orElse(Integer other)

Return the value if present, otherwise return other.

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