org.restlet.ext.wadl
Class IncludeInfo

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

public class IncludeInfo
extends DocumentedInfo

Allows inclusion of grammars by reference.

Author:

Jerome Louvel

Constructor Summary

IncludeInfo()
Constructor.

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

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

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

Method Summary

Reference	getTargetRef() Returns the URI of the referenced definition.
void	setTargetRef(Reference href) Sets the URI of the referenced definition.
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

IncludeInfo

public IncludeInfo()

Constructor.

IncludeInfo

public IncludeInfo(DocumentationInfo documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

IncludeInfo

public IncludeInfo(List<DocumentationInfo> documentations)

Constructor with a list of documentation elements.

Parameters:

documentations - The list of documentation elements.

IncludeInfo

public IncludeInfo(String documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

Method Detail

getTargetRef

public Reference getTargetRef()

Returns the URI of the referenced definition.

Returns:

The URI of the referenced definition.

setTargetRef

public void setTargetRef(Reference href)

Sets the URI of the referenced definition.

Parameters:

href - The URI of the referenced definition.

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