Package org.wildfly.security.auth

Enum SupportLevel

java.lang.Object

java.lang.Enum<SupportLevel>

org.wildfly.security.auth.SupportLevel

All Implemented Interfaces:

Serializable, Comparable<SupportLevel>

public enum SupportLevel
extends Enum<SupportLevel>

The different support levels.

Author:

David M. Lloyd

Enum Constant Summary

Enum Constants

Enum Constant	Description
POSSIBLY_SUPPORTED	The given credential type may be supported.
SUPPORTED	The given credential type is definitely supported.
UNSUPPORTED	The given credential type is definitely not supported.

Method Summary

Modifier and Type	Method	Description
boolean	in(SupportLevel v1)	Determine whether this instance is equal to one of the given instances.
boolean	in(SupportLevel... values)	Determine whether this instance is equal to one of the given instances.
boolean	in(SupportLevel v1, SupportLevel v2)	Determine whether this instance is equal to one of the given instances.
boolean	in(SupportLevel v1, SupportLevel v2, SupportLevel v3)	Determine whether this instance is equal to one of the given instances.
boolean	isDefinitelySupported()	Determine if this object represents definite support.
static boolean	isFull(EnumSet<SupportLevel> set)	Determine whether the given set is fully populated (or "full"), meaning it contains all possible values.
boolean	isNotSupported()	Determine if this object represents definite lack of support.
static SupportLevel	max(SupportLevel o1, SupportLevel o2)	Get the maximum support level between two candidates.
boolean	mayBeSupported()	Determine if this object represents possible or definite support.
static SupportLevel	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SupportLevel[]	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

UNSUPPORTED

public static final SupportLevel UNSUPPORTED

The given credential type is definitely not supported.

POSSIBLY_SUPPORTED

public static final SupportLevel POSSIBLY_SUPPORTED

The given credential type may be supported.

SUPPORTED

public static final SupportLevel SUPPORTED

The given credential type is definitely supported.

Method Detail

values

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

Returns:

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

valueOf

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

isDefinitelySupported

public boolean isDefinitelySupported()

Determine if this object represents definite support.

Returns:

true if this object represents definite support, false otherwise

mayBeSupported

public boolean mayBeSupported()

Determine if this object represents possible or definite support.

Returns:

true if this object represents possible or definite support, false otherwise

isNotSupported

public boolean isNotSupported()

Determine if this object represents definite lack of support.

Returns:

true if this object represents definite lack of support, false otherwise

isFull

public static boolean isFull(EnumSet<SupportLevel> set)

Determine whether the given set is fully populated (or "full"), meaning it contains all possible values.

Parameters:

set - the set

Returns:

true if the set is full, false otherwise

in

public boolean in(SupportLevel v1)

Determine whether this instance is equal to one of the given instances.

Parameters:

v1 - the first instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(SupportLevel v1,
                  SupportLevel v2)

Determine whether this instance is equal to one of the given instances.

Parameters:

v1 - the first instance

v2 - the second instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(SupportLevel v1,
                  SupportLevel v2,
                  SupportLevel v3)

Determine whether this instance is equal to one of the given instances.

Parameters:

v1 - the first instance

v2 - the second instance

v3 - the third instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(SupportLevel... values)

Determine whether this instance is equal to one of the given instances.

Parameters:

values - the possible values

Returns:

true if one of the instances matches this one, false otherwise

max

public static SupportLevel max(SupportLevel o1,
                               SupportLevel o2)

Get the maximum support level between two candidates.

Parameters:

o1 - the first support level (must not be null)

o2 - the second support level (must not be null)

Returns:

the maximum support level (not null)