org.restlet.ext.wadl

Class OptionInfo

java.lang.Object

org.restlet.ext.wadl.DocumentedInfo

org.restlet.ext.wadl.OptionInfo

public class OptionInfo
extends DocumentedInfo

Defines a potential value for a parent parameter description.

Author:

Jerome Louvel

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getValue() Returns the value of this option element.
void	setValue(String value) Sets the value of this option element.
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

OptionInfo

public OptionInfo()

Constructor.

OptionInfo

public OptionInfo(DocumentationInfo documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

OptionInfo

public OptionInfo(List<DocumentationInfo> documentations)

Constructor with a list of documentation elements.

Parameters:

documentations - The list of documentation elements.

OptionInfo

public OptionInfo(String documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

Method Detail

getValue

public String getValue()

Returns the value of this option element.

Returns:

The value of this option element.

setValue

public void setValue(String value)

Sets the value of this option element.

Parameters:

value - The value of this option element.

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