org.azyva.dragom.execcontext.plugin

Interface WorkspacePlugin

All Superinterfaces:

ExecContextPlugin

public interface WorkspacePlugin
extends ExecContextPlugin

TODO: The workspace implementation can and should know about the various types of directories (the various WorkspaceDir and SystemWorkspaceDir classes) and act accordingly. If it does not know about a specific class, maybe a default generic implementation is feasible. Maybe the workspace dir class could help in implementing such a defaul behavior (random vs fixed directory for instance).

Author:

David Raymond

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WorkspacePlugin.GetWorkspaceDirMode
static class	WorkspacePlugin.WorkspaceDirAccessMode Enumerates the possible Workspace directory access modes for the getWorkspaceDir method.

Method Summary

Modifier and Type	Method and Description
void	deleteWorkspaceDir(WorkspaceDir workspaceDir)
Path	getPathWorkspace()
Set<WorkspaceDir>	getSetWorkspaceDir(Class<? extends WorkspaceDir> workspaceDirClass)
Set<WorkspaceDir>	getSetWorkspaceDir(WorkspaceDir workspaceDirIncomplete)
Path	getWorkspaceDir(WorkspaceDir workspaceDir, EnumSet<WorkspacePlugin.GetWorkspaceDirMode> enumSetGetWorkspaceDirMode, WorkspacePlugin.WorkspaceDirAccessMode workspaceDirAccessMode)
WorkspacePlugin.WorkspaceDirAccessMode	getWorkspaceDirAccessMode(Path pathWorkspaceDir)
WorkspaceDir	getWorkspaceDirConflict(WorkspaceDir workspaceDir)
WorkspaceDir	getWorkspaceDirFromPath(Path pathWorkspaceDir)
boolean	isPathWorkspaceDirExists(Path pathWorkspaceDir)
boolean	isSupportMultipleModuleVersion()
boolean	isWorkspaceDirExist(WorkspaceDir workspaceDir)
void	releaseWorkspaceDir(Path pathWorkspaceDir)
void	updateWorkspaceDir(WorkspaceDir workspaceDir, WorkspaceDir workspaceDirNew)

Method Detail

getPathWorkspace

Path getPathWorkspace()

isSupportMultipleModuleVersion

boolean isSupportMultipleModuleVersion()

Returns:

Indicates if multiple Version's of the same Module can exist in user workspace directories.

isWorkspaceDirExist

boolean isWorkspaceDirExist(WorkspaceDir workspaceDir)

getWorkspaceDirConflict

WorkspaceDir getWorkspaceDirConflict(WorkspaceDir workspaceDir)

getWorkspaceDir

Path getWorkspaceDir(WorkspaceDir workspaceDir,
                     EnumSet<WorkspacePlugin.GetWorkspaceDirMode> enumSetGetWorkspaceDirMode,
                     WorkspacePlugin.WorkspaceDirAccessMode workspaceDirAccessMode)

releaseWorkspaceDir

void releaseWorkspaceDir(Path pathWorkspaceDir)

getWorkspaceDirAccessMode

WorkspacePlugin.WorkspaceDirAccessMode getWorkspaceDirAccessMode(Path pathWorkspaceDir)

updateWorkspaceDir

void updateWorkspaceDir(WorkspaceDir workspaceDir,
                        WorkspaceDir workspaceDirNew)

deleteWorkspaceDir

void deleteWorkspaceDir(WorkspaceDir workspaceDir)

getSetWorkspaceDir

Set<WorkspaceDir> getSetWorkspaceDir(Class<? extends WorkspaceDir> workspaceDirClass)

getSetWorkspaceDir

Set<WorkspaceDir> getSetWorkspaceDir(WorkspaceDir workspaceDirIncomplete)

isPathWorkspaceDirExists

boolean isPathWorkspaceDirExists(Path pathWorkspaceDir)

getWorkspaceDirFromPath

WorkspaceDir getWorkspaceDirFromPath(Path pathWorkspaceDir)