org.restlet.ext.wadl
Class ResourcesInfo

java.lang.Object
  org.restlet.ext.wadl.DocumentedInfo
      org.restlet.ext.wadl.ResourcesInfo

public class ResourcesInfo
extends DocumentedInfo

Describes the root resources of an application.

Author:

Jerome Louvel

Constructor Summary

ResourcesInfo()
Constructor.

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

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

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

Method Summary

Reference	getBaseRef() Returns the base URI for each child resource identifier.
List<ResourceInfo>	getResources() Returns the list of child resources.
void	setBaseRef(Reference baseRef) Sets the base URI for each child resource identifier.
void	setResources(List<ResourceInfo> resources) Sets the list of child resources.
void	updateNamespaces(Map<String,String> namespaces) Completes the given map of namespaces with the namespaces used in the documentation elements.
void	writeElement(XmlWriter writer) Writes the current object as an XML element using the given SAX writer.

Methods inherited from class org.restlet.ext.wadl.DocumentedInfo

getDocumentations, resolveNamespaces, setDocumentation, setDocumentation, setDocumentations

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourcesInfo

public ResourcesInfo()

Constructor.

ResourcesInfo

public ResourcesInfo(DocumentationInfo documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

ResourcesInfo

public ResourcesInfo(List<DocumentationInfo> documentations)

Constructor with a list of documentation elements.

Parameters:

documentations - The list of documentation elements.

ResourcesInfo

public ResourcesInfo(String documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

Method Detail

getBaseRef

public Reference getBaseRef()

Returns the base URI for each child resource identifier.

Returns:

The base URI for each child resource identifier.

getResources

public List<ResourceInfo> getResources()

Returns the list of child resources.

Returns:

The list of child resources.

setBaseRef

public void setBaseRef(Reference baseRef)

Sets the base URI for each child resource identifier.

Parameters:

baseRef - The base URI for each child resource identifier.

setResources

public void setResources(List<ResourceInfo> resources)

Sets the list of child resources.

Parameters:

resources - The list of child resources.

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.

writeElement

public void writeElement(XmlWriter writer)
                  throws SAXException

Writes the current object as an XML element using the given SAX writer.

Parameters:

writer - The SAX writer.

Throws:

SAXException