public final class

LabelUtil

extends Object
java.lang.Object
   ↳ com.atlassian.confluence.util.LabelUtil

Class Overview

Utility class designed to assist dealing with the client interface. In particular, the conversion from a string to a label and back, and the conversion from a list of strings to a list of labels and back.

Summary

Constants
String LABEL_DELIM The canonical delimiter in output
String LABEL_DELIM_CHARS The characters accepted as label delimiters
int MAX_ALLOWED_LABELS The maximum number of labels allowed on a page or space.
int MAX_ALLOWED_LABELS_PER_INPUT The maximum number of labels we allow to be entered via a single sumbission from the user interface.
Public Constructors
LabelUtil()
Public Methods
@Deprecated static boolean addLabel(String labelReference, LabelManager labelManager, User user, Labelable dest)
This method is deprecated. since 2.9
static Label addLabel(String labelReference, LabelManager labelManager, Labelable object)
Adds the label to the specified object.
static String convertToDelimitedString(Labelable obj, User user)
Helper method converting list of labels associated with the labelable object into a space separated string of the label names.
static String convertToDelimitedString(List names)
static int countLabels(String input)
Counts the labels present in an input string.
static List<Label> extractLabelsFromLabellings(List<Labelling> labellings)
Simple utility method to extract the label instances from the given list of labelling instances.
static void fixLabels(List suggestedLabels)
static ListFilter getLabelFilters(User user, boolean hideSpecialLabels)
returns only labels the user can see and also strips out special labels if 'hideSpecialLabels' flag is set
static List<Label> getLabelsFor(String labels, LabelManager labelManager)
static List getRecentAndPopularLabels(String spaceKey, LabelManager labelManager, int maxResults, String user)
static List getRecentAndPopularLabelsForEntity(ContentEntityObject entity, LabelManager labelManager, int maxResults, String user)
static List getVisibleLabelNames(List labels, String username)
Get a list of the visible label names for this content.
static boolean isValidLabelLength(String input)
static boolean isValidLabelLengths(String concatenatedLabelNames)
static boolean isValidLabelLengths(Collection labelNames)
static boolean isValidLabelName(String labelName)
static boolean isValidLabelNames(String delimitedLabelNames)
static boolean isValidLabelNames(Collection names)
static String joinIds(List labels, String separator)
static List rankResults(List results)
static void recordLabelInteractionInHistory(Label label)
static List<String> split(String input)
Split the input string according to the label delimitation rules.
static boolean syncState(String source, LabelManager labelManager, User user, Labelable dest, boolean removeUnusedLabels)
Neat method that will synchronize a space separated list of label names with the labels contained within the labelable object.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String LABEL_DELIM

The canonical delimiter in output

Constant Value: " "

public static final String LABEL_DELIM_CHARS

The characters accepted as label delimiters

Constant Value: " ,"

public static final int MAX_ALLOWED_LABELS

The maximum number of labels allowed on a page or space.

Constant Value: 500 (0x000001f4)

public static final int MAX_ALLOWED_LABELS_PER_INPUT

The maximum number of labels we allow to be entered via a single sumbission from the user interface.

Constant Value: 20 (0x00000014)

Public Constructors

public LabelUtil ()

Public Methods

@Deprecated public static boolean addLabel (String labelReference, LabelManager labelManager, User user, Labelable dest)

This method is deprecated.
since 2.9

See Also

public static Label addLabel (String labelReference, LabelManager labelManager, Labelable object)

Adds the label to the specified object. The label is a string in the form of an unparsed label, and is validated by isValidLabelName(String) and isValidLabelLength(String).

If the label can't be added, already exists, or is invalid, this method returns null.
Returns
  • the label that was created and added or null if no label was added.

public static String convertToDelimitedString (Labelable obj, User user)

Helper method converting list of labels associated with the labelable object into a space separated string of the label names.

public static String convertToDelimitedString (List names)

public static int countLabels (String input)

Counts the labels present in an input string. Counts each appearance of duplicate labels.

Parameters
input a string of labels delimited by the characters in LABEL_DELIM_CHARS. May be null or empty.
Returns
  • the number of labels present in the string. Returns 0 for empty or null strings.

public static List<Label> extractLabelsFromLabellings (List<Labelling> labellings)

Simple utility method to extract the label instances from the given list of labelling instances.

Returns
  • a new list containing the referenced Label instances.

public static void fixLabels (List suggestedLabels)

public static ListFilter getLabelFilters (User user, boolean hideSpecialLabels)

returns only labels the user can see and also strips out special labels if 'hideSpecialLabels' flag is set

public static List<Label> getLabelsFor (String labels, LabelManager labelManager)

public static List getRecentAndPopularLabels (String spaceKey, LabelManager labelManager, int maxResults, String user)

public static List getRecentAndPopularLabelsForEntity (ContentEntityObject entity, LabelManager labelManager, int maxResults, String user)

public static List getVisibleLabelNames (List labels, String username)

Get a list of the visible label names for this content. System labels and personal labels that do not belong to this user will be stripped. Visible non-global label names will have their namespace prefixed( i.e. my:foo, team:bar)

Parameters
labels the list of Label objects to filter
username the user who the list is being filtered for
Returns
  • a list of the names of the labels as Strings that the user can see

public static boolean isValidLabelLength (String input)

public static boolean isValidLabelLengths (String concatenatedLabelNames)

public static boolean isValidLabelLengths (Collection labelNames)

public static boolean isValidLabelName (String labelName)

public static boolean isValidLabelNames (String delimitedLabelNames)

Parameters
delimitedLabelNames contains a list of label names delimited by LABEL_DELIM_CHARS
Returns
  • true if the delimitedLabelNames represents a string of valid label names, false otherwise.

public static boolean isValidLabelNames (Collection names)

Parameters
names a collection of label names as Strings.
Returns
  • true if the delimitedLabelNames represents a string of valid label names, false otherwise.

public static String joinIds (List labels, String separator)

public static List rankResults (List results)

public static void recordLabelInteractionInHistory (Label label)

public static List<String> split (String input)

Split the input string according to the label delimitation rules.

Returns
  • a collection of strings, each representing a label name, in the order in which they appeared in the original input.

public static boolean syncState (String source, LabelManager labelManager, User user, Labelable dest, boolean removeUnusedLabels)

Neat method that will synchronize a space separated list of label names with the labels contained within the labelable object. Labels that do not exist in the comma separated list will be removed, and labels that appear in the comma separated list will be created.

If a label is removed and that label no longer labels any labelable content, then it will be deleted if the removeUnusedLabels is set to true.
Parameters
source is a space separated list of label names, eg: the following list "LabelA LabelB LabelC" will be converted into label instances with the names 'LabelA', 'LabelB' and 'LabelC'