org.restlet.ext.wadl

Class ApplicationInfo

java.lang.Object

org.restlet.ext.wadl.DocumentedInfo

org.restlet.ext.wadl.ApplicationInfo

public class ApplicationInfo
extends DocumentedInfo

Root of a WADL description document.

Author:

Jerome Louvel

Constructor Summary

Constructors

Constructor and Description
ApplicationInfo() Constructor.
ApplicationInfo(DocumentationInfo documentation) Constructor with a single documentation element.
ApplicationInfo(List<DocumentationInfo> documentations) Constructor with a list of documentation elements.
ApplicationInfo(String documentation) Constructor with a single documentation element.

Method Summary

Modifier and Type	Method and Description
GrammarsInfo	getGrammars() Returns the grammar elements.
List<MethodInfo>	getMethods() Returns the list of method elements.
Map<String,String>	getNamespaces() Returns the map of namespaces used in the WADL document.
List<RepresentationInfo>	getRepresentations() Returns the list of representation elements.
ResourcesInfo	getResources() Returns the resources root element.
List<ResourceTypeInfo>	getResourceTypes() Returns the list of resource type elements.
void	setGrammars(GrammarsInfo grammars) Sets the grammars element.
void	setMethods(List<MethodInfo> methods) Sets the list of documentation elements.
void	setNamespaces(Map<String,String> namespaces) Sets the map of namespaces used in the WADL document.
void	setRepresentations(List<RepresentationInfo> representations) Sets the list of representation elements.
void	setResources(ResourcesInfo resources) Sets the list of resource elements.
void	setResourceTypes(List<ResourceTypeInfo> resourceTypes) Sets the list of resource type elements.
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

ApplicationInfo

public ApplicationInfo()

Constructor.

ApplicationInfo

public ApplicationInfo(DocumentationInfo documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

ApplicationInfo

public ApplicationInfo(List<DocumentationInfo> documentations)

Constructor with a list of documentation elements.

Parameters:

documentations - The list of documentation elements.

ApplicationInfo

public ApplicationInfo(String documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

Method Detail

getGrammars

public GrammarsInfo getGrammars()

Returns the grammar elements.

Returns:

The grammar elements.

getMethods

public List<MethodInfo> getMethods()

Returns the list of method elements.

Returns:

The list of method elements.

getNamespaces

public Map<String,String> getNamespaces()

Returns the map of namespaces used in the WADL document.

Returns:

The ap of namespaces used in the WADL document.

getRepresentations

public List<RepresentationInfo> getRepresentations()

Returns the list of representation elements.

Returns:

The list of representation elements.

getResources

public ResourcesInfo getResources()

Returns the resources root element.

Returns:

The resources root element.

getResourceTypes

public List<ResourceTypeInfo> getResourceTypes()

Returns the list of resource type elements.

Returns:

The list of resource type elements.

setGrammars

public void setGrammars(GrammarsInfo grammars)

Sets the grammars element.

Parameters:

grammars - The grammars element.

setMethods

public void setMethods(List<MethodInfo> methods)

Sets the list of documentation elements.

Parameters:

methods - The list of method elements.

setNamespaces

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

Sets the map of namespaces used in the WADL document. The key is the URI of the namespace and the value, the prefix.

Parameters:

namespaces - The map of namespaces used in the WADL document.

setRepresentations

public void setRepresentations(List<RepresentationInfo> representations)

Sets the list of representation elements.

Parameters:

representations - The list of representation elements.

setResources

public void setResources(ResourcesInfo resources)

Sets the list of resource elements.

Parameters:

resources - The list of resource elements.

setResourceTypes

public void setResourceTypes(List<ResourceTypeInfo> resourceTypes)

Sets the list of resource type elements.

Parameters:

resourceTypes - The list of resource type elements.

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