Package org.trellisldp.http.domain

Class Prefer

java.lang.Object

org.trellisldp.http.domain.Prefer

public class Prefer
extends java.lang.Object

A class representing an HTTP Prefer header

See Also:

RFC 7240 and IANA values

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PREFER_HANDLING
static java.lang.String	PREFER_INCLUDE
static java.lang.String	PREFER_LENIENT
static java.lang.String	PREFER_MINIMAL
static java.lang.String	PREFER_OMIT
static java.lang.String	PREFER_REPRESENTATION
static java.lang.String	PREFER_RETURN
static java.lang.String	PREFER_STRICT
static java.lang.String	PREFER_WAIT

Constructor Summary

Constructors

Constructor	Description
Prefer(java.lang.String preference, java.util.List<java.lang.String> include, java.util.List<java.lang.String> omit, java.util.Set<java.lang.String> params, java.lang.String handling, java.lang.Integer wait)	Create a Prefer header representation

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	getDepthNoroot()	Identify whether the depth-noroot parameter was set
java.util.Optional<java.lang.String>	getHandling()	Get the handling type
java.util.List<java.lang.String>	getInclude()	Get the preferred include IRIs
java.util.List<java.lang.String>	getOmit()	Get the preferred omit IRIs
java.util.Optional<java.lang.String>	getPreference()	Get the preferred return type
java.lang.Boolean	getRespondAsync()	Identify whether the respond-async parameter was set
java.util.Optional<java.lang.Integer>	getWait()	Get the value of the wait parameter, if set
static Prefer	ofInclude(java.lang.String... includes)	Build a Prefer object with a set of included IRIs
static Prefer	ofOmit(java.lang.String... omits)	Build a Prefer object with a set of omitted IRIs
static Prefer	valueOf(java.lang.String value)	Create a Prefer header representation from a header string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREFER_REPRESENTATION

public static final java.lang.String PREFER_REPRESENTATION

See Also:

Constant Field Values

PREFER_MINIMAL

public static final java.lang.String PREFER_MINIMAL

See Also:

Constant Field Values

PREFER_STRICT

public static final java.lang.String PREFER_STRICT

See Also:

Constant Field Values

PREFER_LENIENT

public static final java.lang.String PREFER_LENIENT

See Also:

Constant Field Values

PREFER_RETURN

public static final java.lang.String PREFER_RETURN

See Also:

Constant Field Values

PREFER_INCLUDE

public static final java.lang.String PREFER_INCLUDE

See Also:

Constant Field Values

PREFER_OMIT

public static final java.lang.String PREFER_OMIT

See Also:

Constant Field Values

PREFER_HANDLING

public static final java.lang.String PREFER_HANDLING

See Also:

Constant Field Values

PREFER_WAIT

public static final java.lang.String PREFER_WAIT

See Also:

Constant Field Values

Constructor Detail

Prefer

public Prefer(java.lang.String preference,
              java.util.List<java.lang.String> include,
              java.util.List<java.lang.String> omit,
              java.util.Set<java.lang.String> params,
              java.lang.String handling,
              java.lang.Integer wait)

Create a Prefer header representation

Parameters:

preference - the preference value

include - a list of include values

omit - a list of omit values

params - single-valued parameters

handling - the handling value

wait - the wait value

Method Detail

valueOf

public static Prefer valueOf(java.lang.String value)

Create a Prefer header representation from a header string

Parameters:

value - the header value

Returns:

a Prefer object or null on an invalid string

getPreference

public java.util.Optional<java.lang.String> getPreference()

Get the preferred return type

Returns:

the preferred return type

getHandling

public java.util.Optional<java.lang.String> getHandling()

Get the handling type

Returns:

the preferred handling type

getWait

public java.util.Optional<java.lang.Integer> getWait()

Get the value of the wait parameter, if set

Returns:

the value of the wait parameter, if available

getRespondAsync

public java.lang.Boolean getRespondAsync()

Identify whether the respond-async parameter was set

Returns:

true if the respond-async parameter was set; false otherwise

getDepthNoroot

public java.lang.Boolean getDepthNoroot()

Identify whether the depth-noroot parameter was set

Returns:

true if the depth-noroot parameter was set; false otherwise

getInclude

public java.util.List<java.lang.String> getInclude()

Get the preferred include IRIs

Returns:

the list of IRIs to be included in the representation

getOmit

public java.util.List<java.lang.String> getOmit()

Get the preferred omit IRIs

Returns:

the list of IRIs to be omitted from the representation

ofInclude

public static Prefer ofInclude(java.lang.String... includes)

Build a Prefer object with a set of included IRIs

Parameters:

includes - the IRIs to include

Returns:

the Prefer object

ofOmit

public static Prefer ofOmit(java.lang.String... omits)

Build a Prefer object with a set of omitted IRIs

Parameters:

omits - the IRIs to omit

Returns:

the Prefer object