Package com.xwiki.task.macro

Enum TaskMacroParameters.IdDisplay

java.lang.Object

java.lang.Enum<TaskMacroParameters.IdDisplay>

com.xwiki.task.macro.TaskMacroParameters.IdDisplay

All Implemented Interfaces:

Serializable, Comparable<TaskMacroParameters.IdDisplay>

Enclosing class:

TaskMacroParameters

public static enum TaskMacroParameters.IdDisplay
extends Enum<TaskMacroParameters.IdDisplay>

We define the values for the isDisplayed property as an enum in order to be able to detect when the property is not set.

Since:

3.8.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
FALSE	Denotes that the id should not be displayed.
TRUE	Denotes that the id should be displayed.

Method Summary

Modifier and Type	Method	Description
static TaskMacroParameters.IdDisplay	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TaskMacroParameters.IdDisplay[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRUE

public static final TaskMacroParameters.IdDisplay TRUE

Denotes that the id should be displayed.

FALSE

public static final TaskMacroParameters.IdDisplay FALSE

Denotes that the id should not be displayed.

Method Detail

values

public static TaskMacroParameters.IdDisplay[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TaskMacroParameters.IdDisplay c : TaskMacroParameters.IdDisplay.values())
    System.out.println(c);

Returns:

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

valueOf

public static TaskMacroParameters.IdDisplay valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null