org.restlet.ext.wadl

Class ResourceTypeInfo

java.lang.Object

org.restlet.ext.wadl.DocumentedInfo

org.restlet.ext.wadl.ResourceTypeInfo

public class ResourceTypeInfo
extends DocumentedInfo

Describes a reusable type of resources.

Author:

Jerome Louvel

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getIdentifier() Returns the identifier for that element.
List<MethodInfo>	getMethods() Returns the list of supported methods.
List<ParameterInfo>	getParameters() Returns the list of parameters.
void	setIdentifier(String identifier) Sets the identifier for that element.
void	setMethods(List<MethodInfo> methods) Sets the list of supported methods.
void	setParameters(List<ParameterInfo> parameters) Sets the list of parameters.
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

ResourceTypeInfo

public ResourceTypeInfo()

Constructor.

ResourceTypeInfo

public ResourceTypeInfo(DocumentationInfo documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

ResourceTypeInfo

public ResourceTypeInfo(List<DocumentationInfo> documentations)

Constructor with a list of documentation elements.

Parameters:

documentations - The list of documentation elements.

ResourceTypeInfo

public ResourceTypeInfo(String documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

Method Detail

getIdentifier

public String getIdentifier()

Returns the identifier for that element.

Returns:

The identifier for that element.

getMethods

public List<MethodInfo> getMethods()

Returns the list of supported methods.

Returns:

The list of supported methods.

getParameters

public List<ParameterInfo> getParameters()

Returns the list of parameters.

Returns:

The list of parameters.

setIdentifier

public void setIdentifier(String identifier)

Sets the identifier for that element.

Parameters:

identifier - The identifier for that element.

setMethods

public void setMethods(List<MethodInfo> methods)

Sets the list of supported methods.

Parameters:

methods - The list of supported methods.

setParameters

public void setParameters(List<ParameterInfo> parameters)

Sets the list of parameters.

Parameters:

parameters - The list of parameters.

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