org.apache.jetspeed.capabilities

Interface MediaType

public interface MediaType

This entry describes all the properties that should be present in a RegistryEntry describing a MediaType TODO: add some additional attributes for separating 2 versions of the same mime type

Version:

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

Author:

Raphaël Luta

Method Summary

Methods

Modifier and Type	Method and Description
void	addCapability(Capability capability) Add Capability to the Capability collection
void	addMimetype(MimeType mimeType) Add MimeType to the MimeType map
Collection<Capability>	getCapabilities() Returns all supported capablities as CapabilityMap.
String	getCharacterSet()
String	getDescription() Get MediaType description
int	getMediatypeId() Get MediaType ID -- Return ID
Collection<MimeType>	getMimetypes() Returns all supported mimetypes as MimeTypeMap.
String	getName() Get Name of MediaType
String	getTitle() Get Title of MediaType
void	removeMimetype(String name) Removes the MimeType to the MimeType map
void	setCapabilities(Collection<Capability> capabilities) Set the capabilities
void	setCharacterSet(String charSet) Sets the character set associated with this MediaType
void	setDescription(String desc) Set description of MediaType
void	setMediatypeId(int id) Set MediaType ID -- Assigns ID
void	setMimetypes(Collection<MimeType> mimetypes) Set mime types
void	setName(String name) Set Name of MediaType
void	setTitle(String title) Set MediaType title

Method Detail

setMediatypeId

void setMediatypeId(int id)

Set MediaType ID -- Assigns ID

Parameters:

id -

getMediatypeId

int getMediatypeId()

Get MediaType ID -- Return ID

Returns:

MediaTypeID

getCharacterSet

String getCharacterSet()

Returns:

the character set associated with this MediaType

setCharacterSet

void setCharacterSet(String charSet)

Sets the character set associated with this MediaType

getCapabilities

Collection<Capability> getCapabilities()

Returns all supported capablities as CapabilityMap. The CapabilityMap contains all capabilities in arbitrary order.

Returns:

a collection of capabilities

setCapabilities

void setCapabilities(Collection<Capability> capabilities)

Set the capabilities

Parameters:

capabilities - of capabilities

getMimetypes

Collection<MimeType> getMimetypes()

Returns all supported mimetypes as MimeTypeMap. The MimeTypeMap contains all mimetypes in decreasing order of importance.

Returns:

the MimeTypeMap

See Also:

MimeType

setMimetypes

void setMimetypes(Collection<MimeType> mimetypes)

Set mime types

Parameters:

mimetypes -

removeMimetype

void removeMimetype(String name)

Removes the MimeType to the MimeType map

Parameters:

name - of MimeType to remove

addMimetype

void addMimetype(MimeType mimeType)

Add MimeType to the MimeType map

Parameters:

mimeType - mimetype object to add

addCapability

void addCapability(Capability capability)

Add Capability to the Capability collection

Parameters:

capability - capability object to add

setName

void setName(String name)

Set Name of MediaType

Parameters:

name - Name of MediaType

getName

String getName()

Get Name of MediaType

Returns:

Name of MediaType

getTitle

String getTitle()

Get Title of MediaType

Returns:

Title of MediaType

setTitle

void setTitle(String title)

Set MediaType title

Parameters:

title -

getDescription

String getDescription()

Get MediaType description

Returns:

Returns description of MediaType

setDescription

void setDescription(String desc)

Set description of MediaType

Parameters:

desc - Description string