com.atlassian.confluence.labels
Class Label

java.lang.Object
  com.atlassian.core.bean.EntityObject
      com.atlassian.confluence.labels.Label

All Implemented Interfaces:

Addressable, ContentTypeAware, DisplayableLabel, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class Label
extends com.atlassian.core.bean.EntityObject
implements java.lang.Comparable, Addressable, java.io.Serializable, DisplayableLabel

See Also:

Serialized Form

Constructor Summary

Label()

Label(java.lang.String name)

Label(java.lang.String name, Namespace namespace)

Label(java.lang.String name, Namespace namespace, java.lang.String owner)

Label(java.lang.String name, java.lang.String namespace, java.lang.String owner)

Method Summary

int	compareTo(java.lang.Object o)
boolean	equals(java.lang.Object o) Equals implementation is a value based implementation.
java.lang.String	getDisplayTitle()
java.lang.String	getName() Returns the label's name only.
Namespace	getNamespace()
java.lang.String	getOwner()
java.lang.String	getRealTitle() Return the title as a combination of the namespace and the label name.
java.lang.String	getType()
java.lang.String	getUrlPath() Generates the url path for a label.
java.lang.String	getUrlPath(java.lang.String spaceKey) Generates the url path for a label in the context of a given space i.e.
int	hashCode()
boolean	isNew()
boolean	isPersistent() This label is persistent iff the id is not 0.
boolean	isRealTitleSafeForUrl() Returns true if the label's title is safe to pass in the URL.
boolean	isTeamLabel()
boolean	isVisibleTo(java.lang.String username) Determines whether the label should be made visible to a particular user.
java.lang.String	toString()
java.lang.String	toStringWithNamespace()
java.lang.String	toStringWithOwnerPrefix()

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

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

getId

Constructor Detail

Label

public Label()

Label

public Label(java.lang.String name)

Label

public Label(java.lang.String name,
             Namespace namespace)

Label

public Label(java.lang.String name,
             java.lang.String namespace,
             java.lang.String owner)

Label

public Label(java.lang.String name,
             Namespace namespace,
             java.lang.String owner)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: DisplayableLabel

Returns the label's name only.

eg. label name for label my:foo is "foo".

Specified by:

getName in interface DisplayableLabel

getOwner

public java.lang.String getOwner()

getNamespace

public Namespace getNamespace()

getType

public java.lang.String getType()

Specified by:

getType in interface ContentTypeAware

Returns:

the content type

equals

public boolean equals(java.lang.Object o)

Equals implementation is a value based implementation. It does not take into account the 'persistence' state of this label instance.

Overrides:

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

Returns:

true if the specified object is considered value equivalent.

hashCode

public int hashCode()

Overrides:

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

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

getRealTitle

public java.lang.String getRealTitle()

Description copied from interface: DisplayableLabel

Return the title as a combination of the namespace and the label name.

Specified by:

getRealTitle in interface DisplayableLabel

getDisplayTitle

public java.lang.String getDisplayTitle()

Specified by:

getDisplayTitle in interface Addressable

Returns:

the title of the addressable object, suitable for display in a list

isRealTitleSafeForUrl

public boolean isRealTitleSafeForUrl()

Description copied from interface: DisplayableLabel

Returns true if the label's title is safe to pass in the URL.

eg. my:foo is safe, perc% is not safe. chicken+cheese is safe in a "combined" label.

Specified by:

isRealTitleSafeForUrl in interface DisplayableLabel

Returns:

true if the label's title is safe to pass in the URL.

getUrlPath

public java.lang.String getUrlPath()

Description copied from interface: DisplayableLabel

Generates the url path for a label.

Specified by:

getUrlPath in interface Addressable

Specified by:

getUrlPath in interface DisplayableLabel

getUrlPath

public java.lang.String getUrlPath(java.lang.String spaceKey)

Description copied from interface: DisplayableLabel

Generates the url path for a label in the context of a given space i.e. the user is taken to a page that contains content for that space only. If no space if provided, DisplayableLabel.getUrlPath() is called.

Specified by:

getUrlPath in interface DisplayableLabel

isNew

public boolean isNew()

isPersistent

public boolean isPersistent()

This label is persistent iff the id is not 0.

Returns:

true if this instance is a persisted label.

isVisibleTo

public boolean isVisibleTo(java.lang.String username)

Determines whether the label should be made visible to a particular user. This does not check the permissions on labelled content, you will need to do that separately

Parameters:

username - the username of the user who wishes to see the label

Returns:

true if the user is permitted to see it, false otherwise

toStringWithOwnerPrefix

public java.lang.String toStringWithOwnerPrefix()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringWithNamespace

public java.lang.String toStringWithNamespace()

isTeamLabel

public boolean isTeamLabel()