Package org.opencms.security

Enum I_CmsPermissionHandler.LockCheck

java.lang.Object

java.lang.Enum<I_CmsPermissionHandler.LockCheck>

org.opencms.security.I_CmsPermissionHandler.LockCheck

All Implemented Interfaces:

Serializable, Comparable<I_CmsPermissionHandler.LockCheck>, java.lang.constant.Constable

Enclosing interface:

I_CmsPermissionHandler

public static enum I_CmsPermissionHandler.LockCheck
extends Enum<I_CmsPermissionHandler.LockCheck>

Enum for the lock check mode.

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
no	Don't check locks.
shallowOnly	Check for shallow or normal lock.
yes	Check for normal (non-shallow) lock.

Method Summary

Modifier and Type	Method	Description
String	getCode()	Gets the code for the enum value.
static I_CmsPermissionHandler.LockCheck	valueOf(String name)	Returns the enum constant of this type with the specified name.
static I_CmsPermissionHandler.LockCheck[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

no

public static final I_CmsPermissionHandler.LockCheck no

Don't check locks.

shallowOnly

public static final I_CmsPermissionHandler.LockCheck shallowOnly

Check for shallow or normal lock.

yes

public static final I_CmsPermissionHandler.LockCheck yes

Check for normal (non-shallow) lock.

Method Details

values

public static I_CmsPermissionHandler.LockCheck[] 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 I_CmsPermissionHandler.LockCheck 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

getCode

public String getCode()

Gets the code for the enum value.

The code is a short string identifying the enum value for use in cache keys.

Returns:

the code