de.twenty11.skysail.server.restlet

Class RepresentationInfo

java.lang.Object

de.twenty11.skysail.server.restlet.DocumentedInfo

de.twenty11.skysail.server.restlet.RepresentationInfo

public class RepresentationInfo
extends DocumentedInfo

Constructor Summary

Constructors

Constructor and Description
RepresentationInfo() Constructor.
RepresentationInfo(DocumentationInfo documentation) Constructor with a single documentation element.
RepresentationInfo(List<DocumentationInfo> documentations) Constructor with a list of documentation elements.
RepresentationInfo(org.restlet.data.MediaType mediaType) Constructor with a media type.
RepresentationInfo(String documentation) Constructor with a single documentation element.
RepresentationInfo(org.restlet.representation.Variant variant) Constructor with a variant.

Method Summary

Methods

Modifier and Type	Method and Description
String	getIdentifier() Returns the identifier for that element.
org.restlet.data.MediaType	getMediaType() Returns the media type of that element.
List<ParameterInfo>	getParameters() Returns the list of parameters.
List<org.restlet.data.Reference>	getProfiles() Returns the list of locations of one or more meta data profiles.
String	getReference() Returns the reference to an representation identifier.
String	getXmlElement() Returns the qualified name of the root element for this XML-based representation.
void	setIdentifier(String identifier) Sets the identifier for that element.
void	setMediaType(org.restlet.data.MediaType mediaType) Sets the media type of that element.
void	setParameters(List<ParameterInfo> parameters) Sets the list of parameters.
void	setReference(String reference) Sets the reference to an representation identifier.
void	setXmlElement(String xmlElement) Sets the qualified name of the root element for this XML-based representation.
String	toString()
void	updateNamespaces(Map<String,String> namespaces) Completes the given map of namespaces with the namespaces used in the documentation elements.

Methods inherited from class de.twenty11.skysail.server.restlet.DocumentedInfo

getDocumentations, resolveNamespaces, setDocumentation, setDocumentation, setDocumentations

Methods inherited from class java.lang.Object

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

Constructor Detail

RepresentationInfo

public RepresentationInfo()

Constructor.

RepresentationInfo

public RepresentationInfo(DocumentationInfo documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

RepresentationInfo

public RepresentationInfo(List<DocumentationInfo> documentations)

Constructor with a list of documentation elements.

Parameters:

documentations - The list of documentation elements.

RepresentationInfo

public RepresentationInfo(org.restlet.data.MediaType mediaType)

Constructor with a media type.

Parameters:

mediaType - The media type of the representation.

RepresentationInfo

public RepresentationInfo(String documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

RepresentationInfo

public RepresentationInfo(org.restlet.representation.Variant variant)

Constructor with a variant.

Parameters:

variant - The variant to describe.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getIdentifier

public String getIdentifier()

Returns the identifier for that element.

Returns:

The identifier for that element.

getMediaType

public org.restlet.data.MediaType getMediaType()

Returns the media type of that element.

Returns:

The media type of that element.

getParameters

public List<ParameterInfo> getParameters()

Returns the list of parameters.

Returns:

The list of parameters.

getProfiles

public List<org.restlet.data.Reference> getProfiles()

Returns the list of locations of one or more meta data profiles.

Returns:

The list of locations of one or more meta data profiles.

getReference

public String getReference()

Returns the reference to an representation identifier.

Returns:

The reference to an representation identifier.

getXmlElement

public String getXmlElement()

Returns the qualified name of the root element for this XML-based representation.

Returns:

The qualified name of the root element for this XML-based representation.

setIdentifier

public void setIdentifier(String identifier)

Sets the identifier for that element.

Parameters:

identifier - The identifier for that element.

setMediaType

public void setMediaType(org.restlet.data.MediaType mediaType)

Sets the media type of that element.

Parameters:

mediaType - The media type of that element.

setParameters

public void setParameters(List<ParameterInfo> parameters)

Sets the list of parameters.

Parameters:

parameters - The list of parameters.

setReference

public void setReference(String reference)

Sets the reference to an representation identifier.

Parameters:

reference - The reference to an representation identifier.

setXmlElement

public void setXmlElement(String xmlElement)

Sets the qualified name of the root element for this XML-based representation.

Parameters:

xmlElement - The qualified name of the root element for this XML-based representation.

updateNamespaces

public void updateNamespaces(Map<String,String> namespaces)

Description copied from class: DocumentedInfo

Completes the given map of namespaces with the namespaces used in the documentation elements. The key is the URI of the namespace and the value, the prefix.

Specified by:

updateNamespaces in class DocumentedInfo

Parameters:

namespaces - The given map of namespaces to complete.