com.atlassian.confluence.labels

Class Labelling

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.confluence.labels.Labelling

All Implemented Interfaces:

Serializable, Cloneable

public class Labelling
extends com.atlassian.core.bean.EntityObject
implements Serializable

An ostensibly immutable object that represents the link between labels and the content they label.

This represents a union type, internally only one of content, attachment or pagetemplate should be not null for any instance of a Labelling, this is what will be returned from getContent.

The labelableType and labelableId fields in this class are summary fields, and are present to make the queries around popular and related labels easier.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Labelling() Available so that newInstance can be used by hibernate to create this object.
Labelling(Label label, EditableLabelable labelable, ConfluenceUser user)
Labelling(Label label, EditableLabelable labelable, String user) Deprecated. since 5.2.

Method Summary

Modifier and Type	Method and Description
Labelling	copy()
Labelling	copy(EditableLabelable labelable) Copies the current Labelling, but providing it with a new EditableLabelable.
boolean	equals(Object o)
protected Attachment	getAttachment() Deprecated. Since 5.7. Use getContent() instead
protected ContentEntityObject	getContent()
Label	getLabel()
EditableLabelable	getLableable() Getter for the content entity object associated with this labelling.
ConfluenceUser	getOwningUser()
protected PageTemplate	getPageTemplate()
String	getUser() Deprecated. since 5.2. User getOwningUser() instead.
int	hashCode()
protected void	setAttachment(Attachment attachment) Deprecated. Since 5.7. Use setContent(com.atlassian.confluence.core.ContentEntityObject) instead
protected void	setContent(ContentEntityObject ceo)
protected void	setLabelable(EditableLabelable labelable) Setter for the content entity object associated with this labelling.
protected void	setPageTemplate(PageTemplate pageTemplate)
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Labelling

@Deprecated
public Labelling(Label label,
                             EditableLabelable labelable,
                             String user)

Deprecated. since 5.2.

Parameters:

label -

labelable -

user - the username of the user who owns this Labellings

Throws:

IllegalArgumentException - if the user does not identify a known user

Labelling

public Labelling(Label label,
                 EditableLabelable labelable,
                 ConfluenceUser user)

Labelling

public Labelling()

Available so that newInstance can be used by hibernate to create this object.

Method Detail

getLableable

public EditableLabelable getLableable()

Getter for the content entity object associated with this labelling.

Returns:

content

setLabelable

protected void setLabelable(EditableLabelable labelable)

Setter for the content entity object associated with this labelling.

getLabel

public Label getLabel()

getUser

@Deprecated
public String getUser()

Deprecated. since 5.2. User getOwningUser() instead.

getOwningUser

public ConfluenceUser getOwningUser()

Since:

5.2

equals

public boolean equals(Object o)

Overrides:

equals in class com.atlassian.core.bean.EntityObject

hashCode

public int hashCode()

Overrides:

hashCode in class com.atlassian.core.bean.EntityObject

toString

public String toString()

Overrides:

toString in class Object

getAttachment

@Deprecated
protected Attachment getAttachment()

Deprecated. Since 5.7. Use getContent() instead

getPageTemplate

protected PageTemplate getPageTemplate()

getContent

protected ContentEntityObject getContent()

setAttachment

@Deprecated
protected void setAttachment(Attachment attachment)

Deprecated. Since 5.7. Use setContent(com.atlassian.confluence.core.ContentEntityObject) instead

setPageTemplate

protected void setPageTemplate(PageTemplate pageTemplate)

setContent

protected void setContent(ContentEntityObject ceo)

copy

public Labelling copy()

copy

public Labelling copy(EditableLabelable labelable)

Copies the current Labelling, but providing it with a new EditableLabelable.