org.nuxeo.apidoc.api

Class AbstractDocumentationItem

java.lang.Object

org.nuxeo.apidoc.api.AbstractDocumentationItem

All Implemented Interfaces:

Comparable<DocumentationItem>, DocumentationItem

Direct Known Subclasses:

DocumentationItemDocAdapter, ResourceDocumentationItem, SimpleDocumentationItem

public abstract class AbstractDocumentationItem
extends Object
implements DocumentationItem

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	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

Modifier	Constructor and Description
protected	AbstractDocumentationItem(String typeLabel)

Method Summary

Modifier and Type	Method and Description
int	compareTo(DocumentationItem o)
String	getTypeLabel() Gets label for the documentation type
static String	typeLabelOf(String type)

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

getApplicableVersion, getAttachments, getContent, getEditId, getId, getRenderingType, getTarget, getTargetType, getTitle, getType, getUUID, isApproved, isPlaceHolder, isReadOnly

Field Detail

log

protected static final org.apache.commons.logging.Log log

Constructor Detail

AbstractDocumentationItem

protected AbstractDocumentationItem(String typeLabel)

Method Detail

compareTo

public int compareTo(DocumentationItem o)

Specified by:

compareTo in interface Comparable<DocumentationItem>

getTypeLabel

public String getTypeLabel()

Description copied from interface: DocumentationItem

Gets label for the documentation type

Specified by:

getTypeLabel in interface DocumentationItem

typeLabelOf

public static String typeLabelOf(String type)