Package com.xwiki.macros.showhideif.macro

Enum ShowHideIfMacroParameters.AuthType

java.lang.Object

java.lang.Enum<ShowHideIfMacroParameters.AuthType>

com.xwiki.macros.showhideif.macro.ShowHideIfMacroParameters.AuthType

All Implemented Interfaces:

Serializable, Comparable<ShowHideIfMacroParameters.AuthType>

Enclosing class:

ShowHideIfMacroParameters

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

Version:

$Id: $

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANONYMOUS	Match only if user is not authenticated.
AUTHENTICATED	Match only if user is authenticated.
NONE	Match in any case if the user is authenticated or not.

Method Summary

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

Match in any case if the user is authenticated or not.

AUTHENTICATED

public static final ShowHideIfMacroParameters.AuthType AUTHENTICATED

Match only if user is authenticated.

ANONYMOUS

public static final ShowHideIfMacroParameters.AuthType ANONYMOUS

Match only if user is not authenticated.

Method Detail

values

public static ShowHideIfMacroParameters.AuthType[] 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.AuthType c : ShowHideIfMacroParameters.AuthType.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.AuthType 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