Package org.restlet.ext.wadl

Class DocumentedInfo

java.lang.Object

org.restlet.ext.wadl.DocumentedInfo

Direct Known Subclasses:

ApplicationInfo, GrammarsInfo, IncludeInfo, LinkInfo, MethodInfo, OptionInfo, ParameterInfo, RepresentationInfo, RequestInfo, ResourceInfo, ResourcesInfo, ResourceTypeInfo, ResponseInfo

@Deprecated
public abstract class DocumentedInfo
extends java.lang.Object

Deprecated.

Will be removed in next major release.

Superclass of WADL elements that supports dcumentation.

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<DocumentationInfo>	documentations	Deprecated. Doc elements used to document that element.

Constructor Summary

Constructors

Constructor	Description
DocumentedInfo()	Deprecated. Constructor.
DocumentedInfo(java.lang.String documentation)	Deprecated. Constructor with a single documentation element.
DocumentedInfo(java.util.List<DocumentationInfo> documentations)	Deprecated. Constructor with a list of documentation elements.
DocumentedInfo(DocumentationInfo documentation)	Deprecated. Constructor with a single documentation element.

Method Summary

Modifier and Type	Method	Description
java.util.List<DocumentationInfo>	getDocumentations()	Deprecated. Returns the list of documentation elements.
java.util.Map<java.lang.String,java.lang.String>	resolveNamespaces()	Deprecated. Returns the list of namespaces used in the documentation elements as a map.
private void	resolveNamespaces(org.w3c.dom.Node node, java.util.Map<java.lang.String,java.lang.String> namespaces)	Deprecated. Completes the given map of namespaces with the namespaces of the given node.
void	setDocumentation(java.lang.String documentation)	Deprecated. Set the list of documentation elements with a single element.
void	setDocumentation(DocumentationInfo documentationInfo)	Deprecated. Set the list of documentation elements with a single element.
void	setDocumentations(java.util.List<DocumentationInfo> doc)	Deprecated. Sets the list of documentation elements.
abstract void	updateNamespaces(java.util.Map<java.lang.String,java.lang.String> namespaces)	Deprecated. 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

Field Detail

documentations

private java.util.List<DocumentationInfo> documentations

Deprecated.

Doc elements used to document that element.

Constructor Detail

DocumentedInfo

public DocumentedInfo()

Deprecated.

Constructor.

DocumentedInfo

public DocumentedInfo(DocumentationInfo documentation)

Deprecated.

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

DocumentedInfo

public DocumentedInfo(java.util.List<DocumentationInfo> documentations)

Deprecated.

Constructor with a list of documentation elements.

Parameters:

documentations - The list of documentation elements.

DocumentedInfo

public DocumentedInfo(java.lang.String documentation)

Deprecated.

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

Method Detail

getDocumentations

public java.util.List<DocumentationInfo> getDocumentations()

Deprecated.

Returns the list of documentation elements.

Returns:

The list of documentation elements.

resolveNamespaces

public java.util.Map<java.lang.String,java.lang.String> resolveNamespaces()

Deprecated.

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.

resolveNamespaces

private void resolveNamespaces(org.w3c.dom.Node node,
                               java.util.Map<java.lang.String,java.lang.String> namespaces)

Deprecated.

Completes the given map of namespaces with the namespaces of the given node.

Parameters:

node - The node to analyse.

namespaces - the map of namespaces to complete.

setDocumentation

public void setDocumentation(DocumentationInfo documentationInfo)

Deprecated.

Set the list of documentation elements with a single element.

Parameters:

documentationInfo - A single documentation element.

setDocumentation

public void setDocumentation(java.lang.String documentation)

Deprecated.

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)

Deprecated.

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)

Deprecated.

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.