Package com.atlassian.confluence.labels

Class Label

java.lang.Object
com.atlassian.core.bean.EntityObject
com.atlassian.confluence.core.AnnotatedEntityObject
com.atlassian.confluence.labels.Label
All Implemented Interfaces:
DisplayableLabel, Serializable, Cloneable, Comparable<Label>
@Entity public class Label extends AnnotatedEntityObject implements Comparable<Label>, Serializable, DisplayableLabel
See Also:

  • Constructor Details

  • Method Details

    • getId

      public long getId()
      Overrides:
      getId in class com.atlassian.core.bean.EntityObject

    • getName

      public 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

      @Deprecated public @Nullable String getOwner()
      Deprecated.
      since 5.2. See getOwnerUser() instead.
      Returns:
      the username of the owner of this label.

    • getOwnerUser

      public @Nullable ConfluenceUser getOwnerUser()
      Since:
      5.2

    • getNamespace

      public Namespace getNamespace()

    • getType

      @Deprecated(since="9.3", forRemoval=true) public String getType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 unused

    • equals

      public boolean equals(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(Label otherlabel)
      Specified by:
      compareTo in interface Comparable<Label>

    • getRealTitle

      @Deprecated(since="9.3", forRemoval=true) public String getRealTitle()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 use DisplayableLabel.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

      @Deprecated(since="9.3", forRemoval=true) public String getDisplayTitle()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 use DisplayableLabel.getDisplayTitle()
      Specified by:
      getDisplayTitle in interface DisplayableLabel

    • isRealTitleSafeForUrl

      @Deprecated(since="9.3", forRemoval=true) public boolean isRealTitleSafeForUrl()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 unused
      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

      @Deprecated(since="9.3", forRemoval=true) public String getUrlPath()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 use DisplayableLabel.getUrlPath()
      Description copied from interface: DisplayableLabel
      Generates the url path for a label.
      Specified by:
      getUrlPath in interface DisplayableLabel

    • getUrlPath

      @Deprecated(since="9.3", forRemoval=true) public String getUrlPath(String spaceKey)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 use DisplayableLabel.getUrlPath(String)
      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

      @Deprecated public boolean isNew()
      Deprecated.
      since Confluence 5.1, do not use.
      Deprecated since Confluence 5.1 because this method does not seem to do anything useful.

      Can not find a way to edit a label in Confluence, so getCreationDate() and getLastModificationDate() seem to always be equal, so this method will likely always return true.

      Lack of documentation and seemingly no usage (in Confluence) indicates this method can be removed.

    • 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(@Nullable 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

      @Deprecated(since="9.3", forRemoval=true) public String toStringWithOwnerPrefix()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 use LabelParser.renderWithOwnerPrefix(Label)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toStringWithNamespace

      @Deprecated(since="9.3", forRemoval=true) public String toStringWithNamespace()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 use LabelParser.renderWithNamespace(Label)

    • isTeamLabel

      public boolean isTeamLabel()

    • containsFavouriteLabel

      public static boolean containsFavouriteLabel(Collection<Label> labels, ConfluenceUser user)
      Since:
      9.3