io.takari.incrementalbuild.workspace

Interface Workspace

All Known Implementing Classes:

FilesystemWorkspace, FilesystemWorkspace, FilesystemWorkspace, ProjectWorkspace

public interface Workspace

Workspace provides a layer of indirection between BuildContext and underlying resource (File) store.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Workspace.FileVisitor
static class	Workspace.Mode
static class	Workspace.ResourceStatus

Method Summary

Modifier and Type	Method and Description
void	deleteFile(File file)
Workspace	escalate()
Workspace.Mode	getMode()
Workspace.ResourceStatus	getResourceStatus(File file, long lastModified, long length)
boolean	isDirectory(File file)
boolean	isPresent(File file)
boolean	isRegularFile(File file)
OutputStream	newOutputStream(File file)
void	processOutput(File file)
void	walk(File basedir, Workspace.FileVisitor visitor) Walks a file tree.

Method Detail

getMode

Workspace.Mode getMode()

escalate

Workspace escalate()

isPresent

boolean isPresent(File file)

isRegularFile

boolean isRegularFile(File file)

isDirectory

boolean isDirectory(File file)

deleteFile

void deleteFile(File file)
         throws IOException

Throws:

IOException

processOutput

void processOutput(File file)

newOutputStream

OutputStream newOutputStream(File file)
                      throws IOException

Throws:

IOException

getResourceStatus

Workspace.ResourceStatus getResourceStatus(File file,
                                           long lastModified,
                                           long length)

walk

void walk(File basedir,
          Workspace.FileVisitor visitor)
   throws IOException

Walks a file tree.

Files visited and their status depends on workspace mode.

• NORMAL all files are visited and all file status is reported as NEW. BuildContext is expected to calculate actual input resource status.
• DELTA only NEW, MODIFIED or REMOVED files are visited.
• ESCALATED all files are visited and all file status is reported as NEW. This mode is used when the user has explicitly requested full build in IDE. BuildContext must treat all files as either NEW or MODIFIED.
• SUPPRESSED This mode is used during so-called "configuration" build, when all inputs are assumed up-to-date, no outputs are expected to be created, updated or removed. The idea is to allow host application to collect build configuration information (compile source roots, properties, etc) without doing the actual build.

Throws:

IOException