Package com.atlassian.greenhopper.model.rapid

Enum Class CardColorStrategy

java.lang.Object

java.lang.Enum<CardColorStrategy>

com.atlassian.greenhopper.model.rapid.CardColorStrategy

All Implemented Interfaces:

Serializable, Comparable<CardColorStrategy>, Constable

@ExperimentalApi
public enum CardColorStrategy
extends Enum<CardColorStrategy>

Represents the possible card color strategies which can be configured for a RapidView.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSIGNEE
CUSTOM
ISSUE_TYPE
NONE
PRIORITY

Method Summary

Modifier and Type	Method	Description
String	getDocumentFieldId()	Returns the document field id for this strategy.
String	getId()
boolean	isIndexFieldBasedStrategy()	Returns true if the card color can be extracted directly from the index.
static CardColorStrategy	lookup(String id)
static CardColorStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CardColorStrategy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ISSUE_TYPE

public static final CardColorStrategy ISSUE_TYPE

ASSIGNEE

public static final CardColorStrategy ASSIGNEE

PRIORITY

public static final CardColorStrategy PRIORITY

NONE

public static final CardColorStrategy NONE

CUSTOM

public static final CardColorStrategy CUSTOM

Method Details

values

public static CardColorStrategy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CardColorStrategy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

lookup

public static CardColorStrategy lookup(String id)

getId

public String getId()

getDocumentFieldId

@Nullable
public String getDocumentFieldId()

Returns the document field id for this strategy. This is used to look up the field which defines the color in the index. If null, it means that the color is not stored in the index and needs to be looked up via a query.

isIndexFieldBasedStrategy

public boolean isIndexFieldBasedStrategy()

Returns true if the card color can be extracted directly from the index. This is true for all types except for CUSTOM (which requires executing separate queries for each color) and NONE.