com.ace.moab.api.acl
Enum ACLAffinity

java.lang.Object
  java.lang.Enum<ACLAffinity>
      com.ace.moab.api.acl.ACLAffinity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ACLAffinity>

public enum ACLAffinity
extends java.lang.Enum<ACLAffinity>

This enumeration describes the different values available for describing how a rule is used in establishing access to an object in Moab. Currently, these ACL affinities are used only for granting access to reservations.

Author:

Brady Kimball

Enum Constant Summary

NEGATIVE
Access to the object is repelled using this rule until access is the last choice.

NEUTRAL
Access to the object is not affected by affinity.

POSITIVE
Access to the object is looked at as the first choice.

PREEMPTIBLE
Access to the object given the rule gives preemptible status to the accessor.

REQUIRED
The rule in question must be satisified in order to gain access to the object.

UNAVAILABLE
The rule does not have its affinity available.

Method Summary

static ACLAffinity	parseString(java.lang.String str) Parses a String and converts it into a corresponding ACLAffinity object.
static ACLAffinity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ACLAffinity[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEGATIVE

public static final ACLAffinity NEGATIVE

Access to the object is repelled using this rule until access is the last choice.

NEUTRAL

public static final ACLAffinity NEUTRAL

Access to the object is not affected by affinity.

POSITIVE

public static final ACLAffinity POSITIVE

Access to the object is looked at as the first choice.

PREEMPTIBLE

public static final ACLAffinity PREEMPTIBLE

Access to the object given the rule gives preemptible status to the accessor.

REQUIRED

public static final ACLAffinity REQUIRED

The rule in question must be satisified in order to gain access to the object.

UNAVAILABLE

public static final ACLAffinity UNAVAILABLE

The rule does not have its affinity available.

Method Detail

values

public static final ACLAffinity[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(ACLAffinity c : ACLAffinity.values())
        System.out.println(c);

Returns:

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

valueOf

public static ACLAffinity valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

parseString

public static ACLAffinity parseString(java.lang.String str)
                               throws java.text.ParseException

Parses a String and converts it into a corresponding ACLAffinity object. IF the String is not a recognizable ACLAffinity object, then a ParseException is thrown.

Parameters:

str - the String to parse.

Returns:

an ACLAffinity object associated with the String.

Throws:

java.text.ParseException - thrown if the string does not match any ACLAffinity object.