org.fcrepo.http.commons.domain

Class PreferTag

java.lang.Object

org.fcrepo.http.commons.domain.PreferTag

All Implemented Interfaces:

java.lang.Comparable<PreferTag>

Direct Known Subclasses:

LdpPreferTag

public class PreferTag
extends java.lang.Object
implements java.lang.Comparable<PreferTag>

Parse a single prefer tag, value and any optional parameters

Author:

cabeer

Constructor Summary

Constructors

Constructor and Description
PreferTag(org.glassfish.jersey.message.internal.HttpHeaderReader reader) Parse the prefer tag and parameters out of the header
PreferTag(PreferTag preferTag) Create a new PreferTag from an existing tag
PreferTag(java.lang.String inputTag) Create a blank prefer tag

Method Summary

Methods

Modifier and Type	Method and Description
void	addResponseHeaders(javax.servlet.http.HttpServletResponse servletResponse) Add appropriate response headers to indicate that the incoming preferences were acknowledged
int	compareTo(PreferTag otherTag) We consider tags with the same name to be equal, because the definition of Prefer headers does not permit that tags with the same name be consumed except by selecting for the first appearing tag.
static PreferTag	emptyTag() Create an empty PreferTag
java.util.Map<java.lang.String,java.lang.String>	getParams() Get any additional parameters for the prefer tag
java.lang.String	getTag() Get the tag name
java.lang.String	getValue() Get the default value for the tag

Methods inherited from class java.lang.Object

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

Constructor Detail

PreferTag

public PreferTag(PreferTag preferTag)

Create a new PreferTag from an existing tag

Parameters:

preferTag -

PreferTag

public PreferTag(org.glassfish.jersey.message.internal.HttpHeaderReader reader)
          throws java.text.ParseException

Parse the prefer tag and parameters out of the header

Parameters:

reader -

Throws:

java.text.ParseException

PreferTag

public PreferTag(java.lang.String inputTag)
          throws java.text.ParseException

Create a blank prefer tag

Parameters:

inputTag -

Throws:

java.text.ParseException

Method Detail

emptyTag

public static PreferTag emptyTag()

Create an empty PreferTag

Returns:

getTag

public java.lang.String getTag()

Get the tag name

Returns:

tag name

getValue

public java.lang.String getValue()

Get the default value for the tag

Returns:

default value for the tag

getParams

public java.util.Map<java.lang.String,java.lang.String> getParams()

Get any additional parameters for the prefer tag

Returns:

additional parameters for the prefer tag

addResponseHeaders

public void addResponseHeaders(javax.servlet.http.HttpServletResponse servletResponse)

Add appropriate response headers to indicate that the incoming preferences were acknowledged

Parameters:

servletResponse -

compareTo

public int compareTo(PreferTag otherTag)

We consider tags with the same name to be equal, because the definition of Prefer headers does not permit that tags with the same name be consumed except by selecting for the first appearing tag.

Specified by:

compareTo in interface java.lang.Comparable<PreferTag>

See Also:

Comparable.compareTo(java.lang.Object)