org.jboss.security.acl

Enum BasicACLPermission

java.lang.Object

java.lang.Enum<BasicACLPermission>

org.jboss.security.acl.BasicACLPermission

All Implemented Interfaces:

Serializable, Comparable<BasicACLPermission>, ACLPermission, BitMaskPermission, Permission

public enum BasicACLPermission
extends Enum<BasicACLPermission>
implements BitMaskPermission

This enum defines the basic ACL permissions. Each permission defined here is represented by a unique integer mask value that is a power of 2 (that is, each permission's bitmask has only one bit on).

Author:

Stefan Guilhen

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE
DELETE
READ
UPDATE

Method Summary

Modifier and Type	Method and Description
int	getMaskValue() Obtains this permission's mask value.
String	toBinaryString() Returns the binary representation of this permission.
static BasicACLPermission	valueOf(String name) Returns the enum constant of this type with the specified name.
static BasicACLPermission[]	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

CREATE

public static final BasicACLPermission CREATE

READ

public static final BasicACLPermission READ

UPDATE

public static final BasicACLPermission UPDATE

DELETE

public static final BasicACLPermission DELETE

Method Detail

values

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

Returns:

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

valueOf

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

getMaskValue

public int getMaskValue()

Obtains this permission's mask value.

Specified by:

getMaskValue in interface BitMaskPermission

Returns:

an int representing the value of the bitmask.

toBinaryString

public String toBinaryString()

Returns the binary representation of this permission.

Returns:

a String containing this permission's binary representation.