Package com.intellij.tasks

Class CustomTaskState

java.lang.Object

com.intellij.tasks.CustomTaskState

public class CustomTaskState
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CustomTaskState() For serialization purposes only.
CustomTaskState(java.lang.String id, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
TaskState	asPredefined() Returns corresponding value of TaskState that has the same name as ID of this state.
boolean	equals(java.lang.Object o)
static CustomTaskState	fromPredefined(TaskState state) Creates custom state for which ID is identical to Enum.name of the given predefined state and isPredefined() returns true.
java.lang.String	getId() Unique ID (e.g.
java.lang.String	getPresentableName() Text that describes this state and will be shown to user in UI (unlike ID it's not necessarily unique).
int	hashCode()
boolean	isPredefined() Means that this custom state can be directly mapped to legacy TaskState.
void	setId(java.lang.String id) For serialization purposes only.
void	setPredefined(boolean predefined) For serialization purposes only.
void	setPresentableName(java.lang.String name) For serialization purposes only.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CustomTaskState

public CustomTaskState()

For serialization purposes only.

CustomTaskState

public CustomTaskState(java.lang.String id,
                       java.lang.String name)

Method Detail

getId

public java.lang.String getId()

Unique ID (e.g. number or unique name) of this state that can be used later to update state of an issue in TaskRepository.setTaskState(Task, CustomTaskState).

See Also:

TaskRepository.setTaskState(Task, CustomTaskState)

setId

public void setId(java.lang.String id)

For serialization purposes only.

getPresentableName

public java.lang.String getPresentableName()

Text that describes this state and will be shown to user in UI (unlike ID it's not necessarily unique).

setPresentableName

public void setPresentableName(java.lang.String name)

For serialization purposes only.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

fromPredefined

public static CustomTaskState fromPredefined(TaskState state)

Creates custom state for which ID is identical to Enum.name of the given predefined state and isPredefined() returns true. If your repository provides only fixed set of available states, that are one of those described in TaskState, you may find this methods useful to implement TaskRepository.getAvailableTaskStates(Task).

Returns:

custom task state that represents given predefined state

See Also:

asPredefined(), isPredefined(), TaskRepository.getAvailableTaskStates(Task)

asPredefined

public TaskState asPredefined()

Returns corresponding value of TaskState that has the same name as ID of this state. It's intended to be used for custom states created using fromPredefined(com.intellij.tasks.TaskState).

Returns:

predefined task state as described or null if such state doesn't exists or isPredefined() returns false

See Also:

isPredefined()

isPredefined

public boolean isPredefined()

Means that this custom state can be directly mapped to legacy TaskState. If it's false, asPredefined() returns null. It's intended to be used mainly for compatibility with existing repositories.

See Also:

asPredefined()

setPredefined

public void setPredefined(boolean predefined)

For serialization purposes only.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object