PreferHeader (Apache Marmotta Site 3.3.0 API)

java.lang.Object
- org.apache.marmotta.platform.ldp.webservices.PreferHeader

```
public class PreferHeader
extends Object
```
HTML Prefer Header.

Author:

Jakob Frank

See Also:
http://www.ietf.org/rfc/rfc7240.txt

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PreferHeader.PreferBuilder
Builder for PreferHeader

Nested Classes
Modifier and Type	Class and Description
`static class`	`PreferHeader.PreferBuilder` Builder for PreferHeader

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`HANDLING_LENIENT`
`static String`	`HANDLING_STRICT`
`static org.slf4j.Logger`	`log`
`static String`	`PREFERENCE_HANDLING`
`static String`	`PREFERENCE_RESPOND_ASYNC`
`static String`	`PREFERENCE_RETURN`
`static String`	`PREFERENCE_WAIT`
`static String`	`RETURN_MINIMAL`
`static String`	`RETURN_PARAM_INCLUDE`
`static String`	`RETURN_PARAM_OMIT`
`static String`	`RETURN_REPRESENTATION`

Method Summary

Methods
Modifier and Type	Method and Description
`static PreferHeader.PreferBuilder`	`fromPrefer(PreferHeader prefer)` Create a PreferBuilder initialized with the provided PreferHeader.
`Map<String,String>`	`getParams()` Get the parameters of the prefer-header.
`String`	`getParamValue(String param)` Get the parameter value of the prefer-header, e,g, `val2` from `Prefer: foo="bar"; a1="val1"; a2="val2"` for `header.getParamValue("a2")`.
`String`	`getPreference()` Get the preference, e.g.
`String`	`getPreferenceValue()` Get the value of the preference, e.g.
`static PreferHeader.PreferBuilder`	`prefer(String preference)` Create a PreferBuilder for an arbitrary preference
`static PreferHeader.PreferBuilder`	`preferHandlingLenient()` Create and initialize a PreferBuilder for a `Prefer: handling="lenient"` header.
`static PreferHeader.PreferBuilder`	`preferHandlingStrict()` Create and initialize a PreferBuilder for a `Prefer: handling="strict"` header.
`static PreferHeader.PreferBuilder`	`preferRespondAsync()` Create and initialize a PreferBuilder for a `Prefer: respond-async` header.
`static PreferHeader.PreferBuilder`	`preferReturnMinimal()` Create and initialize a PreferBuilder for a `Prefer: return="minimal"` header.
`static PreferHeader.PreferBuilder`	`preferReturnRepresentation()` Create and initialize a PreferBuilder for a `Prefer: return="representation"` header.
`static PreferHeader.PreferBuilder`	`preferWait(int seconds)` Create and initialize a PreferBuilder for a `Prefer: wait="X"` header.
`String`	`toString()`
`static PreferHeader`	`valueOf(String headerValue)` Parse a PreferHeader.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PREFERENCE_RESPOND_ASYNC
```
public static final String PREFERENCE_RESPOND_ASYNC
```
    See Also:
    Constant Field Values
  - PREFERENCE_RETURN
```
public static final String PREFERENCE_RETURN
```
    See Also:
    Constant Field Values
  - RETURN_REPRESENTATION
```
public static final String RETURN_REPRESENTATION
```
    See Also:
    Constant Field Values
  - RETURN_MINIMAL
```
public static final String RETURN_MINIMAL
```
    See Also:
    Constant Field Values
  - PREFERENCE_WAIT
```
public static final String PREFERENCE_WAIT
```
    See Also:
    Constant Field Values
  - PREFERENCE_HANDLING
```
public static final String PREFERENCE_HANDLING
```
    See Also:
    Constant Field Values
  - HANDLING_STRICT
```
public static final String HANDLING_STRICT
```
    See Also:
    Constant Field Values
  - HANDLING_LENIENT
```
public static final String HANDLING_LENIENT
```
    See Also:
    Constant Field Values
  - RETURN_PARAM_INCLUDE
```
public static final String RETURN_PARAM_INCLUDE
```
    See Also:
    Constant Field Values
  - RETURN_PARAM_OMIT
```
public static final String RETURN_PARAM_OMIT
```
    See Also:
    Constant Field Values
  - log
```
public static org.slf4j.Logger log
```
- Method Detail
  - getPreference
```
public String getPreference()
```
    Get the preference, e.g. foo from Prefer: foo="bar"
    
    Returns:
    the preference of the prefer-header
  - getPreferenceValue
```
public String getPreferenceValue()
```
    Get the value of the preference, e.g. bar from Prefer: foo="bar".
    
    Returns:
    the preference value of the prefer-header
  - getParams
```
public Map<String,String> getParams()
```
    Get the parameters of the prefer-header.
    
    Returns:
    the prefer-parameters
  - getParamValue
```
public String getParamValue(String param)
```
    Get the parameter value of the prefer-header, e,g, val2 from Prefer: foo="bar"; a1="val1"; a2="val2" for header.getParamValue("a2").
    
    Parameters:
    param - the param to get the value of
    
    Returns:
    the value of the requested parameter, or null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - valueOf
```
public static PreferHeader valueOf(String headerValue)
```
    Parse a PreferHeader.
    
    Parameters:
    headerValue - the header value to parse
    
    Returns:
    the parsed PreferHeader
  - preferRespondAsync
```
public static PreferHeader.PreferBuilder preferRespondAsync()
```
    Create and initialize a PreferBuilder for a Prefer: respond-async header.
    
    Returns:
    initialized PreferBuilder
  - preferReturnRepresentation
```
public static PreferHeader.PreferBuilder preferReturnRepresentation()
```
    Create and initialize a PreferBuilder for a Prefer: return="representation" header.
    
    Returns:
    initialized PreferBuilder
  - preferReturnMinimal
```
public static PreferHeader.PreferBuilder preferReturnMinimal()
```
    Create and initialize a PreferBuilder for a Prefer: return="minimal" header.
    
    Returns:
    initialized PreferBuilder
  - preferWait
```
public static PreferHeader.PreferBuilder preferWait(int seconds)
```
    Create and initialize a PreferBuilder for a Prefer: wait="X" header.
    
    Parameters:
    seconds - seconds to wait, the X in the example.
    
    Returns:
    initialized PreferBuilder
  - preferHandlingStrict
```
public static PreferHeader.PreferBuilder preferHandlingStrict()
```
    Create and initialize a PreferBuilder for a Prefer: handling="strict" header.
    
    Returns:
    initialized PreferBuilder
  - preferHandlingLenient
```
public static PreferHeader.PreferBuilder preferHandlingLenient()
```
    Create and initialize a PreferBuilder for a Prefer: handling="lenient" header.
    
    Returns:
    initialized PreferBuilder
  - fromPrefer
```
public static PreferHeader.PreferBuilder fromPrefer(PreferHeader prefer)
```
    Create a PreferBuilder initialized with the provided PreferHeader.
    
    Parameters:
    prefer - the PreferHeader used for initialisation
    
    Returns:
    initialized PreferBuilder
  - prefer
```
public static PreferHeader.PreferBuilder prefer(String preference)
```
    Create a PreferBuilder for an arbitrary preference
    
    Parameters:
    preference - the preference
    
    Returns:
    initialized PreferBuilder

Class PreferHeader

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PREFERENCE_RESPOND_ASYNC

PREFERENCE_RETURN

RETURN_REPRESENTATION

RETURN_MINIMAL

PREFERENCE_WAIT

PREFERENCE_HANDLING

HANDLING_STRICT

HANDLING_LENIENT

RETURN_PARAM_INCLUDE

RETURN_PARAM_OMIT

log

Method Detail

getPreference

getPreferenceValue

getParams

getParamValue

toString

valueOf

preferRespondAsync

preferReturnRepresentation

preferReturnMinimal

preferWait

preferHandlingStrict

preferHandlingLenient

fromPrefer

prefer