de.twenty11.skysail.server.restlet
Class DocumentedInfo

java.lang.Object
  de.twenty11.skysail.server.restlet.DocumentedInfo

Direct Known Subclasses:

ApplicationInfo, MethodInfo, ParameterInfo, RepresentationInfo, RequestInfo, ResourceInfo, ResourcesInfo, ResponseInfo

public abstract class DocumentedInfo
extends Object

Constructor Summary

DocumentedInfo()
Constructor.

DocumentedInfo(DocumentationInfo documentation)
Constructor with a single documentation element.

DocumentedInfo(List<DocumentationInfo> documentations)
Constructor with a list of documentation elements.

DocumentedInfo(String documentation)
Constructor with a single documentation element.

Method Summary

List<DocumentationInfo>	getDocumentations() Returns the list of documentation elements.
Map<String,String>	resolveNamespaces() Returns the list of namespaces used in the documentation elements as a map.
void	setDocumentation(DocumentationInfo documentationInfo) Set the list of documentation elements with a single element.
void	setDocumentation(String documentation) Set the list of documentation elements with a single element.
void	setDocumentations(List<DocumentationInfo> doc) Sets the list of documentation elements.
abstract void	updateNamespaces(Map<String,String> namespaces) Completes the given map of namespaces with the namespaces used in the documentation elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentedInfo

public DocumentedInfo()

Constructor.

DocumentedInfo

public DocumentedInfo(DocumentationInfo documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

DocumentedInfo

public DocumentedInfo(List<DocumentationInfo> documentations)

Constructor with a list of documentation elements.

Parameters:

documentations - The list of documentation elements.

DocumentedInfo

public DocumentedInfo(String documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

Method Detail

getDocumentations

public List<DocumentationInfo> getDocumentations()

Returns the list of documentation elements.

Returns:

The list of documentation elements.

resolveNamespaces

public Map<String,String> resolveNamespaces()

Returns the list of namespaces used in the documentation elements as a map. The key is the URI of the namespace and the value, the prefix.

Returns:

The list of namespaces used in the documentation elements as a map.

setDocumentation

public void setDocumentation(DocumentationInfo documentationInfo)

Set the list of documentation elements with a single element.

Parameters:

documentationInfo - A single documentation element.

setDocumentation

public void setDocumentation(String documentation)

Set the list of documentation elements with a single element.

Parameters:

documentation - A single documentation element.

setDocumentations

public void setDocumentations(List<DocumentationInfo> doc)

Sets the list of documentation elements.

Parameters:

doc - The list of documentation elements.

updateNamespaces

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

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.

Parameters:

namespaces - The given map of namespaces to complete.