org.xwiki.user

Enum UserType

java.lang.Object

java.lang.Enum<UserType>

org.xwiki.user.UserType

All Implemented Interfaces:

Serializable, Comparable<UserType>

@Unstable
public enum UserType
extends Enum<UserType>

The type of the user (simple user, advanced user).

Since:

12.2

Version:

$Id: 1f8cf19a58b2297b775e27932878ca93fa88463b $

See Also:

user profile

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADVANCED Advanced user (sees all possible actions in the UI).
SIMPLE Simple user (hides complex actions in the UI for simplicity).

Method Summary

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

SIMPLE

public static final UserType SIMPLE

Simple user (hides complex actions in the UI for simplicity).

ADVANCED

public static final UserType ADVANCED

Advanced user (sees all possible actions in the UI).

Method Detail

values

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

Returns:

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

valueOf

public static UserType 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

fromString

public static UserType fromString(String typeAsString)

Parameters:

typeAsString - the user type represented as a string ("Simple", "Advanced"). The case is ignored.

Returns:

the UserType object matching the passed string representation. All values different than advanced are considered to represent a simple user