|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.shared.incremental.IncrementalBuildHelper
public class IncrementalBuildHelper
Various helper methods to support incremental builds
Field Summary | |
---|---|
static String |
CREATED_FILES_LST_FILENAME
|
Constructor Summary | |
---|---|
IncrementalBuildHelper(MojoExecution mojoExecution,
MavenProject mavenProject)
|
|
IncrementalBuildHelper(MojoExecution mojoExecution,
MavenSession mavenSession)
|
Method Summary | |
---|---|
void |
afterRebuildExecution()
This method collects and stores all information about files changed since the call to beforeRebuildExecution(java.io.File) . |
String[] |
beforeRebuildExecution(File outputDirectory)
This method shall get invoked before the actual mojo task gets triggered, e.g. the actual compile in maven-compiler-plugin. |
DirectoryScanner |
getDirectoryScanner()
Get the existing DirectoryScanner used by this helper, or create new a DirectoryScanner if none is yet set. |
File |
getMojoStatusDirectory()
We use a specific status directory for each mojo execution to store state which is needed during the next build invocation run. |
boolean |
inputFileTreeChanged(DirectoryScanner dirScanner)
Detect whether the list of detected files picked up by the DirectoryScanner has changed since the last build. |
boolean |
inputFileTreeChanged(Set<File> inputFiles)
Detect whether the list of detected files has changed since the last build. |
void |
setDirectoryScanner(DirectoryScanner directoryScanner)
Set the DirectoryScanner which shall get used by this build helper. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String CREATED_FILES_LST_FILENAME
Constructor Detail |
---|
public IncrementalBuildHelper(MojoExecution mojoExecution, MavenSession mavenSession)
public IncrementalBuildHelper(MojoExecution mojoExecution, MavenProject mavenProject)
Method Detail |
---|
public DirectoryScanner getDirectoryScanner()
public void setDirectoryScanner(DirectoryScanner directoryScanner)
directoryScanner
- public File getMojoStatusDirectory() throws MojoExecutionException
MojoExecutionException
public boolean inputFileTreeChanged(Set<File> inputFiles) throws MojoExecutionException
inputFiles
-
true
if the set of inputFiles got changed since the last build.
MojoExecutionException
public boolean inputFileTreeChanged(DirectoryScanner dirScanner) throws MojoExecutionException
dirScanner
-
true
if the set of inputFiles got changed since the last build.
MojoExecutionException
public String[] beforeRebuildExecution(File outputDirectory) throws MojoExecutionException
This method shall get invoked before the actual mojo task gets triggered, e.g. the actual compile in maven-compiler-plugin.
Attention: This method shall only get invoked if the plugin re-creates all the output.
It first picks up the list of files created in the previous build and delete them. This step is necessary to prevent left-overs. After that we take a 'directory snapshot' (list of all files which exist in the outputDirectory after the clean).
After the actual mojo task got executed you should invoke the method
afterRebuildExecution()
to collect the list of files which got changed
by this task.
outputDirectory
-
MojoExecutionException
public void afterRebuildExecution() throws MojoExecutionException
This method collects and stores all information about files changed since
the call to beforeRebuildExecution(java.io.File)
.
Attention: This method shall only get invoked if the plugin re-creates all the output.
MojoExecutionException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |