com.atlassian.confluence.pages
Class Comment

java.lang.Object
  extended by com.atlassian.core.bean.EntityObject
      extended by com.atlassian.confluence.core.ConfluenceEntityObject
          extended by com.atlassian.confluence.core.AbstractVersionedEntityObject
              extended by com.atlassian.confluence.core.ContentEntityObject
                  extended by com.atlassian.confluence.pages.Comment
All Implemented Interfaces:
com.atlassian.bonnie.Searchable, Addressable, ContentTypeAware, HasLinkWikiMarkup, Versioned, Labelable, Serializable, Cloneable, Comparable

public class Comment
extends ContentEntityObject
implements HasLinkWikiMarkup

See Also:
Serialized Form

Field Summary
static String CONTENT_TYPE
           
 
Fields inherited from class com.atlassian.confluence.core.ContentEntityObject
CREATED, CURRENT, DELETED, MODIFIED
 
Fields inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject
INITIAL_VERSION
 
Constructor Summary
Comment()
           
 
Method Summary
 void addChild(Comment child)
           
 Object clone()
           
 void convertToHistoricalVersion()
          Remove all data from the object that does not need to be saved by historical versions.
 List<Comment> getChildren()
           
 ContentEntityObject getContentEntityObject()
           
 int getDepth()
           
 Set<String> getDescendantAuthors()
           
 int getDescendantsCount()
           
 String getDisplayTitle()
          Returns the display title.
 String getLinkWikiMarkup()
           
 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.
 ContentEntityObject getOwner()
           
 AbstractPage getPage()
          Deprecated. since 4.0. Please use getOwner() instead.
 Comment getParent()
           
 Space getSpace()
          Deprecated. Since 3.3 Use getOwner()
 String getSpaceKey()
          Deprecated. 
 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<Comment> children)
           
 void setOwner(ContentEntityObject owner)
           
 void setPage(AbstractPage page)
          Deprecated. Since 3.3 Use setOwner(com.atlassian.confluence.core.ContentEntityObject)
 void setParent(Comment parent)
           
 
Methods inherited from class com.atlassian.confluence.core.ContentEntityObject
addAttachment, addComment, addLabelling, addOutgoingLink, addPermission, addReferralLink, addTrackbackLink, compareTo, equals, getAttachmentNamed, getAttachments, getAttachmentsUrlPath, getAttachmentUrlPath, getBodyAsString, getBodyAsStringWithoutMarkup, getBodyContent, getBodyContent, getBodyContents, getComments, getContentPermission, getContentPermissionSet, getContentStatus, getDefaultBodyType, getExcerpt, getGlobalLabels, getIdAsString, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getLabelUtil, getLatestVersionsOfAttachments, getOutgoingLinks, getPermissions, getPersonalLabels, getReferralLinks, getRenderedVersionComment, getSearchableDependants, getTeamLabels, getTitle, getTrackbackLinks, getTypeEnum, getUserAccessor, getVersionComment, getVisibleLabels, hasContentPermissions, hashCode, hasPermissions, isCurrent, isDeleted, isFavourite, isIndexable, isRecentlyUpdatedFor, isVersionCommentAvailable, removeAttachment, removeComment, removeContentPermissionSet, removeLabelling, removeOutgoingLink, removeReferralLink, removeTrackbackLink, setAttachments, setBodyAsString, setBodyContent, setBodyContents, setComments, 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, getRealClass, 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

CONTENT_TYPE

public static final String CONTENT_TYPE
See Also:
Constant Field Values
Constructor Detail

Comment

public Comment()
Method Detail

getContentEntityObject

public ContentEntityObject getContentEntityObject()

getOwner

public ContentEntityObject getOwner()

setOwner

public void setOwner(ContentEntityObject owner)

getPage

@Deprecated
public AbstractPage getPage()
Deprecated. since 4.0. Please use getOwner() instead.

Please use getOwner() instead.


setPage

@Deprecated
public void setPage(AbstractPage page)
Deprecated. Since 3.3 Use setOwner(com.atlassian.confluence.core.ContentEntityObject)


getSpace

@Deprecated
public Space getSpace()
Deprecated. Since 3.3 Use getOwner()


getDisplayTitle

public String getDisplayTitle()
Description copied from class: ContentEntityObject
Returns the display title. Some entities don't have titles for identification. For example, personal information objects use the user's fullname. Override this method to provide a custom title.

Specified by:
getDisplayTitle in interface Addressable
Overrides:
getDisplayTitle in class ContentEntityObject
Returns:
the display title

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 ContentTypeAware
Specified by:
getType in class ContentEntityObject
Returns:
the content type

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

@Deprecated
public String getSpaceKey()
Deprecated. 

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

Returns:
the space key

getParent

public Comment getParent()

setParent

public void setParent(Comment parent)

getChildren

public List<Comment> getChildren()

setChildren

public void setChildren(List<Comment> children)

addChild

public void addChild(Comment child)

getDescendantsCount

public int getDescendantsCount()

getDescendantAuthors

public Set<String> getDescendantAuthors()

getDepth

public int getDepth()

getThreadChangedDate

public Date getThreadChangedDate()

reparentChildren

public void reparentChildren(Comment newParent)

convertToHistoricalVersion

public void convertToHistoricalVersion()
Description copied from interface: Versioned
Remove all data from the object that does not need to be saved by historical versions. For versioned objects that are persisted, this includes removing associations with other persisted objects that may otherwise cause us to break the expected arity of the database relations.

When using Hibernate to persist versioned objects, take special care to null any field that might contain a Hibernate-persisted collection, as Hibernate does not allow two different persistent objects to refer to the same persisted collection at the same time.

Specified by:
convertToHistoricalVersion in interface Versioned
Overrides:
convertToHistoricalVersion in class ContentEntityObject

removeChild

public void removeChild(Comment child)

clone

public Object clone()
             throws CloneNotSupportedException
Overrides:
clone in class ContentEntityObject
Throws:
CloneNotSupportedException

getLinkWikiMarkup

public String getLinkWikiMarkup()
Specified by:
getLinkWikiMarkup in interface HasLinkWikiMarkup
Returns:
the wiki markup used to link to this content


Copyright © 2003-2012 Atlassian. All Rights Reserved.