org.nuxeo.apidoc.documentation

Class ResourceDocumentationItem

java.lang.Object

org.nuxeo.apidoc.api.AbstractDocumentationItem

org.nuxeo.apidoc.documentation.ResourceDocumentationItem

All Implemented Interfaces:

Comparable<DocumentationItem>, DocumentationItem

public class ResourceDocumentationItem
extends AbstractDocumentationItem
implements DocumentationItem

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	applicableVersion
protected String	content
protected String	filename
protected String	target
protected String	targetType
protected String	type

Fields inherited from class org.nuxeo.apidoc.api.AbstractDocumentationItem

log

Fields inherited from interface org.nuxeo.apidoc.api.DocumentationItem

PROP_APPLICABLE_VERSIONS, PROP_DOCUMENTATION_ID, PROP_NUXEO_APPROVED, PROP_RENDERING_TYPE, PROP_TARGET, PROP_TARGET_TYPE, PROP_TYPE, TYPE_NAME

Constructor Summary

Constructors

Constructor and Description
ResourceDocumentationItem(ResourceDocumentationItem other, NuxeoArtifact target)
ResourceDocumentationItem(String filename, String content, String type, NuxeoArtifact target)
ResourceDocumentationItem(String filename, String content, String type, String target, String targetType, List<String> applicableVersion, String typeLabel)

Method Summary

Modifier and Type	Method and Description
List<String>	getApplicableVersion() Gets versions.
Map<String,String>	getAttachments() Returns attachments.
protected String	getCleanName()
String	getContent() Gets the main content of the Documentation
String	getEditId() Return the id used by quick editor (can contains a real UUID for existing doc or an artifact id for new one).
String	getId() Local documentation identifier.
String	getRenderingType() Gets the output rendering format for the content (wiki, html ...)
String	getTarget() Gets identifier of the target documented artifact
String	getTargetType() Gets the Type of the target documented artifact (NXBundle, NXComponent ...).
String	getTitle() Gets Title of the Documentation
String	getType() Gets the type of the documentation (description, how-to, samples ...)
String	getUUID() UUID of the underlying DocumentModel.
boolean	isApproved() Indicates if documentation has been validated by Nuxeo.
boolean	isPlaceHolder() Return true if item is a placeholder automatically generated.
boolean	isReadOnly()

Methods inherited from class org.nuxeo.apidoc.api.AbstractDocumentationItem

compareTo, getTypeLabel, typeLabelOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.apidoc.api.DocumentationItem

getTypeLabel

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

content

protected final String content

filename

protected final String filename

target

protected final String target

targetType

protected final String targetType

type

protected final String type

applicableVersion

protected final List<String> applicableVersion

Constructor Detail

ResourceDocumentationItem

public ResourceDocumentationItem(String filename,
                                 String content,
                                 String type,
                                 String target,
                                 String targetType,
                                 List<String> applicableVersion,
                                 String typeLabel)

ResourceDocumentationItem

public ResourceDocumentationItem(String filename,
                                 String content,
                                 String type,
                                 NuxeoArtifact target)

ResourceDocumentationItem

public ResourceDocumentationItem(ResourceDocumentationItem other,
                                 NuxeoArtifact target)

Method Detail

getTitle

public String getTitle()

Description copied from interface: DocumentationItem

Gets Title of the Documentation

Specified by:

getTitle in interface DocumentationItem

getCleanName

protected String getCleanName()

getContent

public String getContent()

Description copied from interface: DocumentationItem

Gets the main content of the Documentation

Specified by:

getContent in interface DocumentationItem

getType

public String getType()

Description copied from interface: DocumentationItem

Gets the type of the documentation (description, how-to, samples ...)

Specified by:

getType in interface DocumentationItem

getRenderingType

public String getRenderingType()

Description copied from interface: DocumentationItem

Gets the output rendering format for the content (wiki, html ...)

Specified by:

getRenderingType in interface DocumentationItem

getApplicableVersion

public List<String> getApplicableVersion()

Description copied from interface: DocumentationItem

Gets versions.

Specified by:

getApplicableVersion in interface DocumentationItem

getTarget

public String getTarget()

Description copied from interface: DocumentationItem

Gets identifier of the target documented artifact

Specified by:

getTarget in interface DocumentationItem

getTargetType

public String getTargetType()

Description copied from interface: DocumentationItem

Gets the Type of the target documented artifact (NXBundle, NXComponent ...).

Specified by:

getTargetType in interface DocumentationItem

isApproved

public boolean isApproved()

Description copied from interface: DocumentationItem

Indicates if documentation has been validated by Nuxeo.

Specified by:

isApproved in interface DocumentationItem

getId

public String getId()

Description copied from interface: DocumentationItem

Local documentation identifier.

Specified by:

getId in interface DocumentationItem

getUUID

public String getUUID()

Description copied from interface: DocumentationItem

UUID of the underlying DocumentModel.

Specified by:

getUUID in interface DocumentationItem

getAttachments

public Map<String,String> getAttachments()

Description copied from interface: DocumentationItem

Returns attachments.

Specified by:

getAttachments in interface DocumentationItem

isPlaceHolder

public boolean isPlaceHolder()

Description copied from interface: DocumentationItem

Return true if item is a placeholder automatically generated.

Specified by:

isPlaceHolder in interface DocumentationItem

getEditId

public String getEditId()

Description copied from interface: DocumentationItem

Return the id used by quick editor (can contains a real UUID for existing doc or an artifact id for new one).

Specified by:

getEditId in interface DocumentationItem

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface DocumentationItem