Package org.apache.juneau.http.header

Class BasicUriHeader

java.lang.Object

org.apache.juneau.http.header.BasicHeader

org.apache.juneau.http.header.BasicUriHeader

All Implemented Interfaces:

Serializable, Cloneable, Header, NameValuePair

Direct Known Subclasses:

ContentLocation, Location, Referer

public class BasicUriHeader
extends BasicHeader

Category of headers that consist of a single URL value.

Example

Location: http://www.w3.org/pub/WWW/People.html

See Also:

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

Constructor Summary

Constructors

Constructor	Description
BasicUriHeader(String name, String value)	Constructor.
BasicUriHeader(String name, URI value)	Constructor.
BasicUriHeader(String name, Supplier<URI> value)	Constructor with delayed value.

Method Summary

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

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

BasicUriHeader

public BasicUriHeader(String name,
 String value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Must be parsable by URI.create(String).
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicUriHeader

public BasicUriHeader(String name,
 URI value)

Constructor.

Parameters:

name - The header name.

value - The header value.
Can be null.

Throws:

IllegalArgumentException - If name is null or empty.

BasicUriHeader

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

Static creator.

Parameters:

name - The header name.

value - The header value.
Must be parsable by URI.create(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 BasicUriHeader of(String name,
 URI 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 BasicUriHeader of(String name,
 Supplier<URI> 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

asUri

public Optional<URI> asUri()

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

Returns:

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

toUri

public URI toUri()

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

Returns:

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

orElse

public URI orElse(URI other)

Return the value if present, otherwise return other.

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