org.azyva.dragom.execcontext.plugin

Enum WorkspacePlugin.WorkspaceDirAccessMode

java.lang.Object

java.lang.Enum<WorkspacePlugin.WorkspaceDirAccessMode>

org.azyva.dragom.execcontext.plugin.WorkspacePlugin.WorkspaceDirAccessMode

All Implemented Interfaces:

Serializable, Comparable<WorkspacePlugin.WorkspaceDirAccessMode>

Enclosing interface:

WorkspacePlugin

public static enum WorkspacePlugin.WorkspaceDirAccessMode
extends Enum<WorkspacePlugin.WorkspaceDirAccessMode>

Enumerates the possible Workspace directory access modes for the getWorkspaceDir method.

Author:

David Raymond

Enum Constant Summary

Enum Constants

Enum Constant and Description
PEEK Indicates the caller simply wants to peek at the Workspace directory.
READ Indicates the caller will read from the Workspace directory and does not want it to be modified until it is released.
READ_WRITE Indicates the caller will modify the Workspace directory.

Method Summary

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

PEEK

public static final WorkspacePlugin.WorkspaceDirAccessMode PEEK

Indicates the caller simply wants to peek at the Workspace directory. No reservation is actually performed, and the Workspace directory will be returned even if it is being accessed for writing (READ_WRITE). The caller is advised to not perform extensive operations on the Workspace directory that could invalidate it.

READ

public static final WorkspacePlugin.WorkspaceDirAccessMode READ

Indicates the caller will read from the Workspace directory and does not want it to be modified until it is released.

READ_WRITE

public static final WorkspacePlugin.WorkspaceDirAccessMode READ_WRITE

Indicates the caller will modify the Workspace directory.

Method Detail

values

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

Returns:

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

valueOf

public static WorkspacePlugin.WorkspaceDirAccessMode 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