org.azyva.dragom.execcontext.plugin

Enum WorkspacePlugin.GetWorkspaceDirMode

java.lang.Object

java.lang.Enum<WorkspacePlugin.GetWorkspaceDirMode>

org.azyva.dragom.execcontext.plugin.WorkspacePlugin.GetWorkspaceDirMode

All Implemented Interfaces:

Serializable, Comparable<WorkspacePlugin.GetWorkspaceDirMode>

Enclosing interface:

WorkspacePlugin

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

Enumerates the modes when obtaining a WorkspaceDir.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE_IF_NOT_EXIST Create the workspace directory if it does not exist.
DO_NOT_CREATE_PATH Can be specified with CREATE_IF_NOT_EXIST.
MUST_EXIST The workspace directory must not exist.
MUST_NOT_EXIST The workspace directory must already exist.
RESET_IF_EXIST Resets the workspace directory if it exists, as if it was created new (empties it).

Field Summary

Fields

Modifier and Type	Field and Description
static EnumSet<WorkspacePlugin.GetWorkspaceDirMode>	ENUM_SET_CREATE_NEW EnumSet of GetWorkspaceDirMode which means to create a new WorkspaceDir and fail if it already exists.
static EnumSet<WorkspacePlugin.GetWorkspaceDirMode>	ENUM_SET_CREATE_NEW_NO_PATH EnumSet of GetWorkspaceDirMode which means to create a new WorkspaceDir and fail if it already exists.
static EnumSet<WorkspacePlugin.GetWorkspaceDirMode>	ENUM_SET_GET_EXISTING EnumSet of GetWorkspaceDirMode which means to get an existing WorkspaceDir and fail if it does not exist.
static EnumSet<WorkspacePlugin.GetWorkspaceDirMode>	ENUM_SET_GET_EXISTING_OR_CREATE EnumSet of GetWorkspaceDirMode which means to get an existing WorkspaceDir or create a new one if it does not exist.
static EnumSet<WorkspacePlugin.GetWorkspaceDirMode>	ENUM_SET_GET_EXISTING_OR_CREATE_NO_PATH EnumSet of GetWorkspaceDirMode which means to get an existing WorkspaceDir or create a new one if it does not exist.

Method Summary

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

MUST_EXIST

public static final WorkspacePlugin.GetWorkspaceDirMode MUST_EXIST

The workspace directory must not exist. Mutually exclusive with MUST_NOT_EXIST, but none can be specified if existence is not important.

MUST_NOT_EXIST

public static final WorkspacePlugin.GetWorkspaceDirMode MUST_NOT_EXIST

The workspace directory must already exist. Mutually exclusive with MUST_EXIT, but none can be specified if existence is not important.

CREATE_IF_NOT_EXIST

public static final WorkspacePlugin.GetWorkspaceDirMode CREATE_IF_NOT_EXIST

Create the workspace directory if it does not exist. Otherwise do not attempt to create the workspace directory. Can be combined with MUST_NOT_EXIST to force the creation of a new workspace directory. Combining with MUST_EXIST is not useful but works as expected.

DO_NOT_CREATE_PATH

public static final WorkspacePlugin.GetWorkspaceDirMode DO_NOT_CREATE_PATH

Can be specified with CREATE_IF_NOT_EXIST. When specified the behavior is similar to CREATE_IF_NOT_EXIST, but the actual path is not created if it does not exist. This is to support cases where if the workspace directory is new, the path itself must be created by the caller as opposed to starting with an newly created empty path. For example cloning a Git repository requires that the path does not exist. In such as case, teh caller must create it immediately or delete the workspace directory using the deleteWorkspaceDir method. If the caller specifies DO_NOT_CREATE_PATH and CREATE_IF_NOT_EXIST only it can easily detect if the path is new or already exists simply by the existence of the path itself. But if DO_NOT_CREATE_PATH is not specified , the path will always exist upon exit of the method and it may be harder for the caller to distinguish between new and existing paths. Cannot be specified if CREATE_IF_NOT_EXIST is not specified since if the workspace directory exists, the corresponding path must exist (since if ever the caller specifies this flag it must respect the contract to immediately create the path).

RESET_IF_EXIST

public static final WorkspacePlugin.GetWorkspaceDirMode RESET_IF_EXIST

Resets the workspace directory if it exists, as if it was created new (empties it). Otherwise, if the workspace directory exists, reuse it as is. Can be combined with MUST_EXIST to force the reset of the workspace directory. Combining with MUST_NOT_EXIST is not useful but works as expected.

Field Detail

ENUM_SET_GET_EXISTING

public static final EnumSet<WorkspacePlugin.GetWorkspaceDirMode> ENUM_SET_GET_EXISTING

EnumSet of GetWorkspaceDirMode which means to get an existing WorkspaceDir and fail if it does not exist.

ENUM_SET_GET_EXISTING_OR_CREATE

public static final EnumSet<WorkspacePlugin.GetWorkspaceDirMode> ENUM_SET_GET_EXISTING_OR_CREATE

EnumSet of GetWorkspaceDirMode which means to get an existing WorkspaceDir or create a new one if it does not exist.

ENUM_SET_GET_EXISTING_OR_CREATE_NO_PATH

public static final EnumSet<WorkspacePlugin.GetWorkspaceDirMode> ENUM_SET_GET_EXISTING_OR_CREATE_NO_PATH

EnumSet of GetWorkspaceDirMode which means to get an existing WorkspaceDir or create a new one if it does not exist. If the path does not exist, it is not created. Useful for WorkspaceDirUserModuleVersion where the path is expected to be created when performing the checkout from the SCM.

ENUM_SET_CREATE_NEW

public static final EnumSet<WorkspacePlugin.GetWorkspaceDirMode> ENUM_SET_CREATE_NEW

EnumSet of GetWorkspaceDirMode which means to create a new WorkspaceDir and fail if it already exists.

ENUM_SET_CREATE_NEW_NO_PATH

public static final EnumSet<WorkspacePlugin.GetWorkspaceDirMode> ENUM_SET_CREATE_NEW_NO_PATH

EnumSet of GetWorkspaceDirMode which means to create a new WorkspaceDir and fail if it already exists. The path is not created. Useful for WorkspaceDirUserModuleVersion where the path is expected to be created when performing the checkout from the SCM.

Method Detail

values

public static WorkspacePlugin.GetWorkspaceDirMode[] 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.GetWorkspaceDirMode c : WorkspacePlugin.GetWorkspaceDirMode.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.GetWorkspaceDirMode 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