Package com.adobe.granite.security.user

Enum AuthorizableTypes

java.lang.Object

java.lang.Enum<AuthorizableTypes>

com.adobe.granite.security.user.AuthorizableTypes

All Implemented Interfaces:

Serializable, Comparable<AuthorizableTypes>, java.lang.constant.Constable

public enum AuthorizableTypes
extends Enum<AuthorizableTypes>

Enumeration of combinations of authorizable types.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	All authorizables: users (and system users) and groups.
GROUPS	Only groups.
SYSTEM_USERS	Only system users.
USERS	Only users.
USERS_AND_SYSTEM_USERS	All users (including system users).

Method Summary

Modifier and Type	Method	Description
boolean	includesGroups()	Provides a way to determine if this AuthorizableTypes value refers to groups as well.
boolean	includesSystemUsers()	Provides a way to determine if this AuthorizableTypes value refers to system users as well.
boolean	includesUsers()	Provides a way to determine if this AuthorizableTypes value refers to users as well.
static AuthorizableTypes	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AuthorizableTypes[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final AuthorizableTypes ALL

All authorizables: users (and system users) and groups.

USERS

public static final AuthorizableTypes USERS

Only users. System users are excluded.

SYSTEM_USERS

public static final AuthorizableTypes SYSTEM_USERS

Only system users. Regular users are excluded.

USERS_AND_SYSTEM_USERS

public static final AuthorizableTypes USERS_AND_SYSTEM_USERS

All users (including system users).

GROUPS

public static final AuthorizableTypes GROUPS

Only groups.

Method Details

values

public static AuthorizableTypes[] values()

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

Returns:

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

valueOf

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

includesUsers

public boolean includesUsers()

Provides a way to determine if this AuthorizableTypes value refers to users as well. Only regular users (not system users) are reflected by this method.

Returns:

true if the regular users are included by this enum value and false otherwise

includesSystemUsers

public boolean includesSystemUsers()

Provides a way to determine if this AuthorizableTypes value refers to system users as well. Only system users (not regular users) are reflected by this method.

Returns:

true if the system users are included by this enum value and false otherwise

includesGroups

public boolean includesGroups()

Provides a way to determine if this AuthorizableTypes value refers to groups as well.

Returns:

true if the groups are included by this enum value and false otherwise