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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LabelParser.CreateFromString<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	INVALID_PATTERN
static int	MAX_LABEL_LENGTH

Constructor Summary

Constructors

Constructor and Description
LabelParser()

Method Summary

Modifier and Type	Method and Description
static <Y> Set<Y>	buildFromString(LabelParser.CreateFromString<Y> factory, String labelsString) Takes a set of labels represented as a string and parses them out.
static Set<Label>	buildFromString(String labelsString) Takes a set of labels represented as a string and parses them out.
static String	getCleanLabel(String label) Cleans up the label so that it can be stored in JIRA.
static boolean	isValidLabelName(String name) Checks if the label provided contains any invalid chars

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_LABEL_LENGTH

public static final int MAX_LABEL_LENGTH

See Also:

Constant Field Values

INVALID_PATTERN

public static final Pattern INVALID_PATTERN

Constructor Detail

LabelParser

public LabelParser()

Method Detail

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.