org.restlet.ext.wadl
Class DocumentedInfo

java.lang.Object
  extended by org.restlet.ext.wadl.DocumentedInfo
Direct Known Subclasses:
ApplicationInfo, GrammarsInfo, IncludeInfo, LinkInfo, MethodInfo, OptionInfo, ParameterInfo, RepresentationInfo, RequestInfo, ResourceInfo, ResourcesInfo, ResourceTypeInfo, ResponseInfo

public abstract class DocumentedInfo
extends java.lang.Object

Superclass of WADL elements that supports dcumentation.


Constructor Summary
DocumentedInfo()
          Constructor.
DocumentedInfo(DocumentationInfo documentation)
          Constructor with a single documentation element.
DocumentedInfo(java.util.List<DocumentationInfo> documentations)
          Constructor with a list of documentation elements.
DocumentedInfo(java.lang.String documentation)
          Constructor with a single documentation element.
 
Method Summary
 java.util.List<DocumentationInfo> getDocumentations()
          Returns the list of documentation elements.
 java.util.Map<java.lang.String,java.lang.String> resolveNamespaces()
          Returns the list of namespaces used in the documentation elements as a map.
 void setDocumentation(DocumentationInfo documentationInfo)
          Set the list of documentation elements with a single element.
 void setDocumentation(java.lang.String documentation)
          Set the list of documentation elements with a single element.
 void setDocumentations(java.util.List<DocumentationInfo> doc)
          Sets the list of documentation elements.
abstract  void updateNamespaces(java.util.Map<java.lang.String,java.lang.String> namespaces)
          Completes the given map of namespaces with the namespaces used in the documentation elements.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentedInfo

public DocumentedInfo()
Constructor.


DocumentedInfo

public DocumentedInfo(DocumentationInfo documentation)
Constructor with a single documentation element.

Parameters:
documentation - A single documentation element.

DocumentedInfo

public DocumentedInfo(java.util.List<DocumentationInfo> documentations)
Constructor with a list of documentation elements.

Parameters:
documentations - The list of documentation elements.

DocumentedInfo

public DocumentedInfo(java.lang.String documentation)
Constructor with a single documentation element.

Parameters:
documentation - A single documentation element.
Method Detail

getDocumentations

public java.util.List<DocumentationInfo> getDocumentations()
Returns the list of documentation elements.

Returns:
The list of documentation elements.

resolveNamespaces

public java.util.Map<java.lang.String,java.lang.String> resolveNamespaces()
Returns the list of namespaces used in the documentation elements as a map. The key is the URI of the namespace and the value, the prefix.

Returns:
The list of namespaces used in the documentation elements as a map.

setDocumentation

public void setDocumentation(DocumentationInfo documentationInfo)
Set the list of documentation elements with a single element.

Parameters:
documentationInfo - A single documentation element.

setDocumentation

public void setDocumentation(java.lang.String documentation)
Set the list of documentation elements with a single element.

Parameters:
documentation - A single documentation element.

setDocumentations

public void setDocumentations(java.util.List<DocumentationInfo> doc)
Sets the list of documentation elements.

Parameters:
doc - The list of documentation elements.

updateNamespaces

public abstract void updateNamespaces(java.util.Map<java.lang.String,java.lang.String> namespaces)
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.

Parameters:
namespaces - The given map of namespaces to complete.


Copyright © 2005-2008 Noelios Technologies.