com.atlassian.confluence.pages
Class Comment

java.lang.Object
  com.atlassian.core.bean.EntityObject
      com.atlassian.confluence.core.ConfluenceEntityObject
          com.atlassian.confluence.core.AbstractVersionedEntityObject
              com.atlassian.confluence.core.ContentEntityObject
                  com.atlassian.confluence.core.PageContentEntityObject
                      com.atlassian.confluence.pages.Comment

All Implemented Interfaces:

Addressable, Cloneable, Comparable, Labelable, Searchable, Serializable, Versioned

public class Comment

extends PageContentEntityObject

See Also:

Serialized Form

Field Summary

static String	CONTENT_TYPE
protected static org.apache.log4j.Category	log

Fields inherited from class com.atlassian.confluence.core.ContentEntityObject

CREATED, CURRENT, DELETED, MODIFIED

Constructor Summary

Comment()

Method Summary

void	addChild(Comment child)
void	convertToHistoricalVersion()
List	getChildren()
int	getDepth()
Set	getDescendantAuthors()
int	getDescendantsCount()
protected org.apache.log4j.Category	getLog()
String	getNameForComparison() Since the ContentEntityObject falls back on ordering by creation date, comments should always end up being sorted in their order of posting, below the page they were created in.
Comment	getParent()
String	getRealTitle()
String	getSpaceKey() convenience method for lucene to retrieve the key of the space this comment belongs to
Date	getThreadChangedDate()
String	getType() An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.
String	getUrlPath()
void	removeChild(Comment child)
void	reparentChildren(Comment newParent)
void	setChildren(List children)
void	setParent(Comment parent)

Methods inherited from class com.atlassian.confluence.core.PageContentEntityObject

getPage, hashCode, setPage

Methods inherited from class com.atlassian.confluence.core.ContentEntityObject

addAttachment, addLabelling, addOutgoingLink, addPermission, addReferralLink, addTrackbackLink, clone, compareTo, equals, getAttachmentNamed, getAttachments, getAttachmentsUrlPath, getBodyContents, getContent, getContentPermission, getContentPermissionSet, getContentStatus, getExcerpt, getGlobalLabels, getIdAsString, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getLabelUtil, getLatestVersionsOfAttachments, getOutgoingLinks, getPermissions, getPersonalLabels, getReferralLinks, getRenderedVersionComment, getSearchableDependants, getTitle, getTrackbackLinks, getUserAccessor, getVersionComment, getVisibleLabels, isCurrent, isDeleted, isFavourite, isIndexable, isRecentlyUpdatedFor, isVersionCommentAvailable, removeAttachment, removeContentPermissionSet, removeLabelling, removeOutgoingLink, removeReferralLink, removeTrackbackLink, setAttachments, setBodyContents, setContent, setContentStatus, setOutgoingLinks, setReferralLinks, setTitle, setTrackbackLinks, setUserAccessor, setVersionComment, toPageContext, toString, trash

Methods inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject

getLatestVersion, getOriginalVersion, getVersion, isLatestVersion, isNew, setOriginalVersion, setVersion

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject

getCreatorName, getLastModifierName, isPersistent, setCreatorName, setLastModifierName

Methods inherited from class com.atlassian.core.bean.EntityObject

getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.bonnie.Searchable

getId

Methods inherited from interface com.atlassian.confluence.core.Addressable

getId

Field Detail

log

protected static org.apache.log4j.Category log

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

Comment

public Comment()

Method Detail

getRealTitle

public String getRealTitle()

Specified by:

getRealTitle in interface Addressable

Overrides:

getRealTitle in class ContentEntityObject

getUrlPath

public String getUrlPath()

Specified by:

getUrlPath in interface Addressable

Specified by:

getUrlPath in class ContentEntityObject

getType

public String getType()

Description copied from class: ContentEntityObject

An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.

This is a bit of a hack, but it saves heaps of code elsewhere, especially since we tend to get back these objects wrapped in all sorts of Hibernate CGLIB stuff.

Specified by:

getType in interface Addressable

Specified by:

getType in class ContentEntityObject

getNameForComparison

public String getNameForComparison()

Since the ContentEntityObject falls back on ordering by creation date, comments should always end up being sorted in their order of posting, below the page they were created in. Nifty, eh.

Specified by:

getNameForComparison in class ContentEntityObject

getSpaceKey

public String getSpaceKey()

convenience method for lucene to retrieve the key of the space this comment belongs to

Returns:

getParent

public Comment getParent()

setParent

public void setParent(Comment parent)

getChildren

public List getChildren()

setChildren

public void setChildren(List children)

addChild

public void addChild(Comment child)

getDescendantsCount

public int getDescendantsCount()

getDescendantAuthors

public Set getDescendantAuthors()

getDepth

public int getDepth()

getThreadChangedDate

public Date getThreadChangedDate()

reparentChildren

public void reparentChildren(Comment newParent)

convertToHistoricalVersion

public void convertToHistoricalVersion()

Specified by:

convertToHistoricalVersion in interface Versioned

Overrides:

convertToHistoricalVersion in class PageContentEntityObject

removeChild

public void removeChild(Comment child)

getLog

protected org.apache.log4j.Category getLog()

Specified by:

getLog in class ContentEntityObject

Returns:

The category to log for this class