xdi2.messaging.http

Class AcceptHeader

java.lang.Object

xdi2.messaging.http.AcceptHeader

All Implemented Interfaces:

Serializable, Comparable<AcceptHeader>

public class AcceptHeader
extends Object
implements Serializable, Comparable<AcceptHeader>

A helper class that can parse and produce HTTP Accept: headers.

Author:

markus

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<MimeType>	mimeTypes

Constructor Summary

Constructors

Constructor and Description
AcceptHeader()

Method Summary

Modifier and Type	Method and Description
void	addMimeType(MimeType mimeType)
MimeType	bestMimeType(boolean canRead, boolean canWrite) Returns a MimeType that we can support for this Accept header.
int	compareTo(AcceptHeader other)
boolean	containsMimeType(MimeType mimeType)
static AcceptHeader	create(MimeType preferredMimeType) Creates an Accept: header with all the XDI mime types we understand, and optionally with a "preferred" one.
boolean	equals(Object object)
List<MimeType>	getMimeTypes()
List<MimeType>	getMimeTypesSortedByQuality()
int	hashCode()
static AcceptHeader	parse(String header) Creates an Accept: header from a header string.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

mimeTypes

protected List<MimeType> mimeTypes

Constructor Detail

AcceptHeader

public AcceptHeader()

Method Detail

create

public static AcceptHeader create(MimeType preferredMimeType)

Creates an Accept: header with all the XDI mime types we understand, and optionally with a "preferred" one.

Parameters:

preferredMimeType - The preferred mime type.

Returns:

The Accept: header.

parse

public static AcceptHeader parse(String header)

Creates an Accept: header from a header string.

Parameters:

header - The header string.

Returns:

The Accept: header.

bestMimeType

public MimeType bestMimeType(boolean canRead,
                             boolean canWrite)

Returns a MimeType that we can support for this Accept header.

Parameters:

canRead - If true, only return MimeTypes we can read.

canWrite - If true, only return MimeTypes we can write.

Returns:

A MimeType, or null if no appropriate implementation could be found.

getMimeTypes

public List<MimeType> getMimeTypes()

getMimeTypesSortedByQuality

public List<MimeType> getMimeTypesSortedByQuality()

addMimeType

public void addMimeType(MimeType mimeType)

containsMimeType

public boolean containsMimeType(MimeType mimeType)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(AcceptHeader other)

Specified by:

compareTo in interface Comparable<AcceptHeader>