public abstract class DocumentedInfo extends Object
Constructor and Description |
---|
DocumentedInfo()
Constructor.
|
DocumentedInfo(DocumentationInfo documentation)
Constructor with a single documentation element.
|
DocumentedInfo(List<DocumentationInfo> documentations)
Constructor with a list of documentation elements.
|
DocumentedInfo(String documentation)
Constructor with a single documentation element.
|
Modifier and Type | Method and Description |
---|---|
List<DocumentationInfo> |
getDocumentations()
Returns the list of documentation elements.
|
Map<String,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(String documentation)
Set the list of documentation elements with a single element.
|
void |
setDocumentations(List<DocumentationInfo> doc)
Sets the list of documentation elements.
|
abstract void |
updateNamespaces(Map<String,String> namespaces)
Completes the given map of namespaces with the namespaces used in the
documentation elements.
|
public DocumentedInfo()
public DocumentedInfo(DocumentationInfo documentation)
documentation
- A single documentation element.public DocumentedInfo(List<DocumentationInfo> documentations)
documentations
- The list of documentation elements.public DocumentedInfo(String documentation)
documentation
- A single documentation element.public List<DocumentationInfo> getDocumentations()
public Map<String,String> resolveNamespaces()
public void setDocumentation(DocumentationInfo documentationInfo)
documentationInfo
- A single documentation element.public void setDocumentation(String documentation)
documentation
- A single documentation element.public void setDocumentations(List<DocumentationInfo> doc)
doc
- The list of documentation elements.public abstract void updateNamespaces(Map<String,String> namespaces)
namespaces
- The given map of namespaces to complete.Copyright © 2005–2016. All rights reserved.