Package com.atlassian.confluence.labels
Class LabelParser
java.lang.Object
com.atlassian.confluence.labels.LabelParser
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 Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ParsedLabelName
static ParsedLabelName
static String
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.static boolean
isPersonalLabel
(String labelString) Returns true if the label is a personal label, false otherwise.static boolean
isValidLabelLength
(ParsedLabelName labelName) static boolean
isValidNameLength
(ParsedLabelName labelName) static boolean
isValidPrefixLength
(ParsedLabelName labelName) static @Nullable ParsedLabelName
static ParsedLabelName
Deprecated.since 6.0.static String
static String
render
(ParsedLabelName parsedLabelName) static String
render
(ParsedLabelName parsedLabelName, boolean ignoreCurrentUser) static String
render
(ParsedLabelName parsedLabelName, com.atlassian.user.User currentUser) The pure render function without side effects
-
Field Details
-
INVALID_CHARACTERS
Deprecated.since 5.10. UseINVALID_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
- See Also:
-
PERSONAL_LABEL_PREFIX
-
TEAM_LABEL_PREFIX
-
GLOBAL_LABEL_PREFIX
-
USER_LABEL_PREFIX
- See Also:
-
-
Constructor Details
-
LabelParser
public LabelParser()
-
-
Method Details
-
isValidLabelLength
-
isValidNameLength
-
isValidPrefixLength
-
isPersonalLabel
Returns true if the label is a personal label, 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.
-
isLabelOwnedByUser
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 labeluser
- 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.since 6.0. Useparse(String, User)
instead. -
getInvalidCharactersAsString
-
create
-
create
-
render
-
render
-
render
-
render
The pure render function without side effects- Since:
- 7.7.0
-