Package org.apache.juneau.http.header

Class HttpUriHeader

java.lang.Object

org.apache.juneau.http.header.HttpHeaderBean

org.apache.juneau.http.header.HttpUriHeader

All Implemented Interfaces:

HttpHeader

Direct Known Subclasses:

ContentLocation, Location, Referer

public class HttpUriHeader
extends HttpHeaderBean

Base for single-URI headers.

Since:

9.2.1

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LAZY_URI
static final int	LAZY_WIRE_STRING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpUriHeader(String name, String value)	Constructor.
protected	HttpUriHeader(String name, URI value)	Constructor.
protected	HttpUriHeader(String name, Supplier<?> supplier, int lazyMode)	Constructor with lazy value supplier.

Method Summary

Modifier and Type	Method	Description
Optional<URI>	asUri()
String	getValue()	Returns the wire-format value of this header.
static HttpUriHeader	of(String name, String wireValue)	Creates an HttpUriHeader by parsing the given wire-format value.
static HttpUriHeader	of(String name, URI typedValue)	Creates an HttpUriHeader with the given typed value.
URI	orElse(URI other)	Returns the parsed value of this header, or the specified default if unset.
URI	toUri()	Returns the parsed value of this header.

Methods inherited from class org.apache.juneau.http.header.HttpHeaderBean

equals, equalsIgnoreCase, getName, hashCode, of, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LAZY_WIRE_STRING

public static final int LAZY_WIRE_STRING

See Also:

• Constant Field Values

LAZY_URI

public static final int LAZY_URI

See Also:

• Constant Field Values

Constructor Details

HttpUriHeader

protected HttpUriHeader(String name,
 String value)

Constructor.

Parameters:

name - Header name. Must not be null.

value - Wire value. Can be null or empty, in which case the parsed value is null.

HttpUriHeader

protected HttpUriHeader(String name,
 URI value)

Constructor.

Parameters:

name - Header name. Must not be null.

value - The URI value. Can be null, in which case the parsed value is null.

HttpUriHeader

protected HttpUriHeader(String name,
 Supplier<?> supplier,
 int lazyMode)

Constructor with lazy value supplier.

Parameters:

name - Header name. Must not be null.

supplier - The lazy value supplier. Must not be null.

lazyMode - Either LAZY_WIRE_STRING or LAZY_URI.

Method Details

of

public static HttpUriHeader of(String name,
 String wireValue)

Creates an HttpUriHeader by parsing the given wire-format value.

Parameters:

name - Header name. Must not be null.

wireValue - Wire value. May be null or empty.

Returns:

A new instance. Never null.

of

public static HttpUriHeader of(String name,
 URI typedValue)

Creates an HttpUriHeader with the given typed value.

Parameters:

name - Header name. Must not be null.

typedValue - The URI value. May be null.

Returns:

A new instance. Never null.

asUri

public Optional<URI> asUri()

getValue

public String getValue()

Returns the wire-format value of this header.

Specified by:

getValue in interface HttpHeader

Overrides:

getValue in class HttpHeaderBean

Returns:

The wire value, or null if the value is unset.

orElse

public URI orElse(URI other)

Returns the parsed value of this header, or the specified default if unset.

Parameters:

other - The default value. Can be null.

Returns:

The parsed value, or other if the value is unset. Can be null if other is null.

toUri

public URI toUri()

Returns the parsed value of this header.

Returns:

The parsed value, or null if the value is unset.