org.apache.jetspeed.capabilities

Interface CapabilityMap

public interface CapabilityMap

This interface provides lookup features on the capabilities supported by a client user agent.

Version:

$Id: CapabilityMap.java 1536817 2013-10-29 17:11:29Z taylor $

Author:

Raphaël Luta, Kevin A. Burton

Method Summary

Methods

Modifier and Type	Method and Description
void	addCapability(Capability capability) Add capability to the CapabilityMap
void	addMediaType(MediaType mediatype) Add MediaType to the MediaTypeMap
void	addMimetype(MimeType mimetype) Add Mimetype to the MimetypeMap
String	getAgent()
Client	getClient() Returns the Client for the CapabilityMap
Iterator<MimeType>	getMimeTypes() Get the mime types that this CapabilityMap supports.
MediaType	getPreferredMediaType()
MimeType	getPreferredType()
boolean	hasCapability(int capabilityId)
boolean	hasCapability(String capability)
Iterator<MediaType>	listMediaTypes() Returns an ordered list of supported media-types, from most preferred to least preferred
void	setAgent(String userAgent)
void	setClient(Client client) Sets the client for the CapabilityMap
void	setPreferredMediaType(MediaType type) Sets the preferred MediaType for this CapabilityMap
boolean	supportsMediaType(String media) Return true if this CapabilityMap supports the given media type
boolean	supportsMimeType(MimeType mimeType)
String	toString()

Method Detail

setClient

void setClient(Client client)

Sets the client for the CapabilityMap

Parameters:

client - The client associated with this map

getClient

Client getClient()

Returns the Client for the CapabilityMap

Returns:

The client associated with this map

addCapability

void addCapability(Capability capability)

Add capability to the CapabilityMap

Parameters:

capability -

addMimetype

void addMimetype(MimeType mimetype)

Add Mimetype to the MimetypeMap

Parameters:

mimetype -

addMediaType

void addMediaType(MediaType mediatype)

Add MediaType to the MediaTypeMap

Parameters:

mediatype - to add

getPreferredType

MimeType getPreferredType()

Returns:

Returns the preferred MIME type for the current user-agent

getPreferredMediaType

MediaType getPreferredMediaType()

Returns:

Returns the preferred media type for the current user-agent

setPreferredMediaType

void setPreferredMediaType(MediaType type)

Sets the preferred MediaType for this CapabilityMap

Parameters:

type -

listMediaTypes

Iterator<MediaType> listMediaTypes()

Returns an ordered list of supported media-types, from most preferred to least preferred

Returns:

an iterator over all media types

getAgent

String getAgent()

Returns:

Returns the user-agent string

setAgent

void setAgent(String userAgent)

hasCapability

boolean hasCapability(int capabilityId)

Parameters:

capabilityId -

Returns:

Returns true if the current agent has the specified capabilityID

hasCapability

boolean hasCapability(String capability)

Parameters:

capability -

Returns:

returns true if the current agent has the specified capability

getMimeTypes

Iterator<MimeType> getMimeTypes()

Get the mime types that this CapabilityMap supports.

Returns:

Returns an Iterator over the MimeType map

supportsMimeType

boolean supportsMimeType(MimeType mimeType)

Parameters:

mimeType -

Returns:

Return true if this CapabilityMap supports the given MimeType

supportsMediaType

boolean supportsMediaType(String media)

Return true if this CapabilityMap supports the given media type

Parameters:

media - the name of a media type registered in the MediaType registry

Returns:

true is the capabilities of this agent at least match those required by the media type

toString

String toString()

Overrides:

toString in class Object

Returns:

Create a map -> string representation