Package com.atlassian.jira.issue.label

Class LabelParser

java.lang.Object
com.atlassian.jira.issue.label.LabelParser
public class LabelParser extends Object
This class provides a number of static utility methods for validating labels.
Since:
v4.2

  • Field Details

    • MAX_LABEL_LENGTH

      public static final int MAX_LABEL_LENGTH
      See Also:

    • INVALID_PATTERN

      public static final Pattern INVALID_PATTERN

  • Constructor Details

    • LabelParser

      public LabelParser()

  • Method Details

    • isValidLabelName

      public static boolean isValidLabelName(String name)
      Checks if the label provided contains any invalid chars
      Parameters:
      name - The label to check for invalid chars
      Returns:
      true if any invalid chars were found false otherwise

    • getCleanLabel

      public static String getCleanLabel(String label)
      Cleans up the label so that it can be stored in JIRA. It may replace characters in the label to ensure it can be stored within JIRA.
      Parameters:
      label - the label to clean.
      Returns:
      the cleaned label that can be stored in JIRA. Will return null on label that cannot be corrected.

    • buildFromString

      public static Set<Label> buildFromString(String labelsString)
      Takes a set of labels represented as a string and parses them out.
      Parameters:
      labelsString - a String containing labels separated by LabelsField#SEPARATOR_CHAR
      Returns:
      a Set of Label

    • buildFromString

      public static <Y> Set<Y> buildFromString(LabelParser.CreateFromString<Y> factory, String labelsString)
      Takes a set of labels represented as a string and parses them out. Any invalid labels will be transformed to that they become valid.
      Parameters:
      labelsString - the string to parse.
      factory - class that will convert a string to the object required
      Returns:
      the collection of labels contained within the string.