|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.core.bean.EntityObject com.atlassian.confluence.core.ConfluenceEntityObject com.atlassian.confluence.core.AbstractVersionedEntityObject com.atlassian.confluence.core.AbstractLabelableEntityObject com.atlassian.confluence.core.ContentEntityObject com.atlassian.confluence.pages.Comment
public class Comment
Field Summary | |
---|---|
static String |
CONTENT_TYPE
|
static String |
FOOTER
The comment will be found in the page footer (i.e. |
static String |
INLINE
The comment will be found in the page content (aka. |
static String |
INLINE_PROP
ContentProperty key for the property that indicates whether or not
the comment is an inline comment. |
static String |
MARKER_REF_PROP
ContentProperty key for the reference to the selection's markers in storage format |
static String |
ORIGINAL_SELECTION_PROP
ContentProperty key for original selection text of the inline comment |
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 |
getContainer()
|
ContentEntityObject |
getContentEntityObject()
|
ContentId |
getContentId()
Returns the ContentId for this Comment. |
ContentType |
getContentTypeObject()
|
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()
Deprecated. since 5.7. Use getContainer() instead. |
AbstractPage |
getPage()
Deprecated. since 4.0. Please use getOwner() instead. |
Comment |
getParent()
|
Space |
getSpace()
|
String |
getSpaceKey()
Deprecated. |
CommentStatus |
getStatus()
Get the status of comment |
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()
|
boolean |
isInlineComment()
|
void |
removeChild(Comment child)
|
void |
reparentChildren(Comment newParent)
|
void |
setChildren(List<Comment> children)
|
void |
setContainer(ContentEntityObject container)
|
void |
setInlineComment(boolean isInlineComment)
Set if the comment is inline |
void |
setOwner(ContentEntityObject owner)
Deprecated. since 4.0. Please use getContainer() instead. |
void |
setPage(AbstractPage page)
Deprecated. Since 3.3 Use setContainer(ContentEntityObject) |
void |
setParent(Comment parent)
|
void |
setStatus(CommentStatus status)
Set status for comment |
boolean |
shouldConvertToContent()
|
Methods inherited from class com.atlassian.confluence.core.AbstractLabelableEntityObject |
---|
addLabelling, getGlobalLabels, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getLabelUtil, getPersonalLabels, getTeamLabels, getVisibleLabels, isFavourite, isFavourite, removeLabelling, setLabellings |
Methods inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject |
---|
getLatestVersion, getOriginalVersion, getVersion, getVersionChildPolicy, isLatestVersion, isNew, setOriginalVersion, setVersion |
Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject |
---|
getCreator, getCreatorName, getLastModifier, getLastModifierName, getRealClass, isPersistent, setCreator, setCreatorName, setLastModifier, 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 |
Methods inherited from interface com.atlassian.confluence.labels.EditableLabelable |
---|
getId, isPersistent |
Field Detail |
---|
public static final String CONTENT_TYPE
public static final String INLINE_PROP
ContentProperty
key for the property that indicates whether or not
the comment is an inline comment.
public static final String MARKER_REF_PROP
ContentProperty
key for the reference to the selection's markers in storage format
public static final String ORIGINAL_SELECTION_PROP
ContentProperty
key for original selection text of the inline comment
public static final String INLINE
public static final String FOOTER
Constructor Detail |
---|
public Comment()
Method Detail |
---|
public ContentEntityObject getContentEntityObject()
getContentEntityObject
in class ContentEntityObject
public ContentEntityObject getContainer()
getContainer
in interface Contained<ContentEntityObject>
public void setContainer(ContentEntityObject container)
@Deprecated public ContentEntityObject getOwner()
getContainer()
instead.
@Deprecated public void setOwner(ContentEntityObject owner)
getContainer()
instead.
@Deprecated public AbstractPage getPage()
getOwner()
instead.
getOwner()
instead.
@Deprecated public void setPage(AbstractPage page)
setContainer(ContentEntityObject)
public Space getSpace()
getSpace
in interface Spaced
public String getDisplayTitle()
ContentEntityObject
getDisplayTitle
in interface Addressable
getDisplayTitle
in class ContentEntityObject
public String getUrlPath()
getUrlPath
in interface Addressable
getUrlPath
in class ContentEntityObject
public String getType()
ContentEntityObject
getType
in interface ContentTypeAware
getType
in class ContentEntityObject
public String getNameForComparison()
getNameForComparison
in class ContentEntityObject
@Deprecated public String getSpaceKey()
public Comment getParent()
public void setParent(Comment parent)
public List<Comment> getChildren()
public void setChildren(List<Comment> children)
public void addChild(Comment child)
public int getDescendantsCount()
public Set<String> getDescendantAuthors()
public int getDepth()
public Date getThreadChangedDate()
public void reparentChildren(Comment newParent)
public void convertToHistoricalVersion()
Versioned
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.
convertToHistoricalVersion
in interface Versioned
convertToHistoricalVersion
in class ContentEntityObject
public void removeChild(Comment child)
public Object clone() throws CloneNotSupportedException
clone
in class ContentEntityObject
CloneNotSupportedException
public String getLinkWikiMarkup()
getLinkWikiMarkup
in interface HasLinkWikiMarkup
public ContentType getContentTypeObject()
getContentTypeObject
in interface ContentConvertible
public ContentId getContentId()
ContentId
for this Comment.
getContentId
in interface ContentConvertible
getContentId
in class ContentEntityObject
public boolean shouldConvertToContent()
shouldConvertToContent
in interface ContentConvertible
public boolean isInlineComment()
public void setInlineComment(boolean isInlineComment)
isInlineComment
- public CommentStatus getStatus()
public void setStatus(CommentStatus status)
status
- CommentStatus
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |