Package com.atlassian.confluence.labels

Class LabelParser

java.lang.Object
com.atlassian.confluence.labels.LabelParser
public class LabelParser extends Object
The Label parser understands the formatting of label strings.

The following are considered valid label strings. 

  • my:label
    : a user label owned by the currently logged in user. If no user is logged in, this defaults to the global label of the same name..
  • label
    : a global label.
  • ~username:label
    : a user label owned by the specified user.

  • Field Details

    • INVALID_CHARACTERS

      @Deprecated public static final char[] INVALID_CHARACTERS
      Deprecated.
      since 5.10. Use INVALID_LABEL_CHARACTERS

    • MAX_LABEL_NAME_LENGTH

      public static final int MAX_LABEL_NAME_LENGTH
      See Also:

    • MAX_LABEL_PREFIX_LENGTH

      public static final int MAX_LABEL_PREFIX_LENGTH
      See Also:

    • NAMESPACE_DELIMITER

      public static final String NAMESPACE_DELIMITER
      See Also:

    • PERSONAL_LABEL_PREFIX

      public static final String PERSONAL_LABEL_PREFIX

    • TEAM_LABEL_PREFIX

      public static final String TEAM_LABEL_PREFIX

    • GLOBAL_LABEL_PREFIX

      public static final String GLOBAL_LABEL_PREFIX

    • USER_LABEL_PREFIX

      public static final String USER_LABEL_PREFIX
      See Also:

  • Constructor Details

    • LabelParser

      public LabelParser()

  • Method Details

    • isValidLabelLength

      public static boolean isValidLabelLength(ParsedLabelName labelName)

    • isValidNameLength

      public static boolean isValidNameLength(ParsedLabelName labelName)

    • isValidPrefixLength

      public static boolean isValidPrefixLength(ParsedLabelName labelName)

    • isPersonalLabel

      @Deprecated(forRemoval=true, since="9.3") public static boolean isPersonalLabel(String labelString)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 use isPersonalLabel(String, ConfluenceUser)
      Returns true if the label is a personal label for the current user, false otherwise.
      Parameters:
      labelString - a string representation of exactly one label, optionally including a namespace. E.g. "my:favourite", "team:confluence" or "blah". Should not be null.
      Returns:
      true if the label is a personal label, false otherwise.

    • isPersonalLabel

      public static boolean isPersonalLabel(String labelString, ConfluenceUser user)
      Returns true if the label is a personal label for the given user, false otherwise.
      Parameters:
      labelString - a string representation of exactly one label, optionally including a namespace. E.g. "my:favourite", "team:confluence" or "blah". Should not be null.
      Returns:
      true if the label is a personal label, false otherwise.
      Since:
      9.3

    • isLabelOwnedByUser

      public static boolean isLabelOwnedByUser(String labelString, com.atlassian.user.User user)
      Returns true if the label is a personal label and is owned by the specified user, false otherwise. Returns false, if the specified labelString is not a personal or user label (as no other label types have user ownership).
      Parameters:
      labelString - must be user label or personal label
      user - user to check against
      Returns:
      true if the label is a personal label and is owned by the specified user, false otherwise.

    • parse

      public static @Nullable ParsedLabelName parse(@NonNull String labelString, @Nullable com.atlassian.user.User user)
      Since:
      6.0

    • parse

      @Deprecated public static ParsedLabelName parse(String labelString)
      Deprecated.
      since 6.0. Use parse(String, User) instead.

    • getInvalidCharactersAsString

      public static String getInvalidCharactersAsString()

    • create

      public static ParsedLabelName create(String labelName, String userName)

    • create

      public static ParsedLabelName create(Label label)

    • render

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

    • render

      public static String render(Label label, @Nullable ConfluenceUser user)
      Since:
      9.3

    • render

      @Deprecated(since="9.3", forRemoval=true) public static String render(ParsedLabelName parsedLabelName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 use render(ParsedLabelName, User)

    • render

      @Deprecated(since="9.3", forRemoval=true) public static String render(ParsedLabelName parsedLabelName, boolean ignoreCurrentUser)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 use render(ParsedLabelName, User)

    • render

      public static String render(ParsedLabelName parsedLabelName, @Nullable com.atlassian.user.User currentUser)
      The pure render function without side effects
      Since:
      7.7.0

    • renderWithOwnerPrefix

      public static String renderWithOwnerPrefix(Label label)
      Since:
      9.3

    • renderWithNamespace

      public static String renderWithNamespace(Label label)
      Since:
      9.3