Package com.xwiki.macros.showhideif.macro

Enum ShowHideIfMacroParameters.DisplayType

java.lang.Object

java.lang.Enum<ShowHideIfMacroParameters.DisplayType>

com.xwiki.macros.showhideif.macro.ShowHideIfMacroParameters.DisplayType

All Implemented Interfaces:

Serializable, Comparable<ShowHideIfMacroParameters.DisplayType>

Enclosing class:

ShowHideIfMacroParameters

public static enum ShowHideIfMacroParameters.DisplayType
extends Enum<ShowHideIfMacroParameters.DisplayType>

Since:

1.26.0

Version:

$Id: $

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	Dislay in general case except in PRINTABLE cases.
NONE	Display in any cases.
PRINTABLE	Display in printable case.

Method Summary

Modifier and Type	Method	Description
static ShowHideIfMacroParameters.DisplayType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ShowHideIfMacroParameters.DisplayType[]	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

NONE

public static final ShowHideIfMacroParameters.DisplayType NONE

Display in any cases.

DEFAULT

public static final ShowHideIfMacroParameters.DisplayType DEFAULT

Dislay in general case except in PRINTABLE cases.

PRINTABLE

public static final ShowHideIfMacroParameters.DisplayType PRINTABLE

Display in printable case. This include ODT and PDF export and printing.

Method Detail

values

public static ShowHideIfMacroParameters.DisplayType[] 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 (ShowHideIfMacroParameters.DisplayType c : ShowHideIfMacroParameters.DisplayType.values())
    System.out.println(c);

Returns:

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

valueOf

public static ShowHideIfMacroParameters.DisplayType 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