ome.services.graphs

Enum GraphPolicy.Action

java.lang.Object

java.lang.Enum<GraphPolicy.Action>

ome.services.graphs.GraphPolicy.Action

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GraphPolicy.Action>

Enclosing class:

GraphPolicy

public static enum GraphPolicy.Action
extends java.lang.Enum<GraphPolicy.Action>

The action to take on an object instance.

Since:

5.1.0

Author:

m.t.b.carroll@dundee.ac.uk

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELETE delete the object
EXCLUDE do not include the object in the operation
INCLUDE include the object in the operation
OUTSIDE object is inappropriate for the operation and may be related to both included and excluded objects

Method Summary

Modifier and Type	Method and Description
static GraphPolicy.Action	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GraphPolicy.Action[]	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

EXCLUDE

public static final GraphPolicy.Action EXCLUDE

do not include the object in the operation

DELETE

public static final GraphPolicy.Action DELETE

delete the object

INCLUDE

public static final GraphPolicy.Action INCLUDE

include the object in the operation

OUTSIDE

public static final GraphPolicy.Action OUTSIDE

object is inappropriate for the operation and may be related to both included and excluded objects

Method Detail

values

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

Returns:

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

valueOf

public static GraphPolicy.Action 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

java.lang.NullPointerException - if the argument is null