org.azyva.dragom.execcontext

Interface WorkspaceExecContext

public interface WorkspaceExecContext

Interface implemented by ExecContext implementations that support the workspace directory concept.

It is expected that a WorkspacePlugin implementation manage workspace data and that such plugin implementations require a WorkspaceExecContext. In order to support long-lived workspaces, WorkspaceExecContext supports the of workspace format and version that can be used by WorkspacePlugin implementations to validate that existing workspaces are usable.

It is up to WorkspacePlugin implementations to recognize various workspace formats and versions and permit workspace format and version migration.

Author:

David Raymond

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WorkspaceExecContext.WorkspaceFormatVersion Workspace format and version.

Method Summary

Modifier and Type	Method and Description
Path	getPathMetadataDir()
Path	getPathWorkspaceDir()
WorkspaceExecContext.WorkspaceFormatVersion	getWorkspaceFormatVersion()
void	setWorkspaceFormatVersion(WorkspaceExecContext.WorkspaceFormatVersion workspaceFormatVersion)

Method Detail

getPathWorkspaceDir

Path getPathWorkspaceDir()

Returns:

Path to the workspace directory associated with the ExecContext.

getPathMetadataDir

Path getPathMetadataDir()

Returns:

Path to a directory within the workspace directory that contains metadata about the workspace. Plugins and tools can use this directory to store metadata that should remain persisted with the workspace.

getWorkspaceFormatVersion

WorkspaceExecContext.WorkspaceFormatVersion getWorkspaceFormatVersion()

Returns:

WorkspaceFormatVersion. null if workspace has not been initialized.

setWorkspaceFormatVersion

void setWorkspaceFormatVersion(WorkspaceExecContext.WorkspaceFormatVersion workspaceFormatVersion)

Parameters:

workspaceFormatVersion - WorkspaceFormatVersion.