public class ThreadBuildContext extends Object implements BuildContext
setThreadBuildContext(BuildContext)
.
DefaultBuildContext
is used if no thread local build context was set.
Note that plexus component metadata is not generated for this implementation.
Apparently, older version of plexus used by maven-filtering and likely
other projects, does not honour "default" role-hint.SEVERITY_ERROR, SEVERITY_WARNING
Constructor and Description |
---|
ThreadBuildContext() |
Modifier and Type | Method and Description |
---|---|
void |
addError(File file,
int line,
int column,
String message,
Throwable cause)
Deprecated.
Use addMessage with severity=SEVERITY_ERROR instead
|
void |
addMessage(File file,
int line,
int column,
String message,
int severity,
Throwable cause)
Adds a message to the build context.
|
void |
addWarning(File file,
int line,
int column,
String message,
Throwable cause)
Deprecated.
Use addMessage with severity=SEVERITY_WARNING instead
|
static BuildContext |
getContext() |
Object |
getValue(String key)
Returns value associated with
key during previous mojo execution. |
boolean |
hasDelta(File file)
Returns
true if the file has changed since last build or is not
under basedir. |
boolean |
hasDelta(List relPaths)
Returns
true if any file or folder identified by relpaths has
changed since last build. |
boolean |
hasDelta(String relPath)
Returns
true if file or folder identified by relpath has
changed since last build. |
boolean |
isIncremental()
Returns
true if this build context is incremental. |
boolean |
isUptodate(File target,
File source)
Returns true, if the target file exists and is uptodate compared to the source file.
|
org.codehaus.plexus.util.Scanner |
newDeleteScanner(File basedir)
Returned Scanner scans
basedir for files and directories
deleted since last build. |
OutputStream |
newFileOutputStream(File file)
Returns new OutputStream that writes to the
file . |
org.codehaus.plexus.util.Scanner |
newScanner(File basedir)
Convenience method, fully equal to newScanner(basedir, false)
|
org.codehaus.plexus.util.Scanner |
newScanner(File basedir,
boolean ignoreDelta)
Returned Scanner scans files and folders under
basedir . |
void |
refresh(File file)
Indicates that the file or folder content has been modified during the build.
|
void |
removeMessages(File file)
Removes all messages associated with a file or folder during a previous build.
|
static void |
setThreadBuildContext(BuildContext context) |
void |
setValue(String key,
Object value)
Associate specified
key with specified value
in the build context. |
public static BuildContext getContext()
public static void setThreadBuildContext(BuildContext context)
public boolean hasDelta(String relPath)
BuildContext
true
if file or folder identified by relpath
has
changed since last build.hasDelta
in interface BuildContext
relPath
- is path relative to build context basedirpublic boolean hasDelta(File file)
BuildContext
true
if the file has changed since last build or is not
under basedir.hasDelta
in interface BuildContext
public boolean hasDelta(List relPaths)
BuildContext
true
if any file or folder identified by relpaths
has
changed since last build.hasDelta
in interface BuildContext
relPaths
- Listpublic org.codehaus.plexus.util.Scanner newDeleteScanner(File basedir)
BuildContext
basedir
for files and directories
deleted since last build. Returns empty Scanner if basedir
is not under this build context basedir.newDeleteScanner
in interface BuildContext
public OutputStream newFileOutputStream(File file) throws IOException
BuildContext
file
.
Files changed using OutputStream returned by this method do not need to be
explicitly refreshed using BuildContext.refresh(File)
.
As an optional optimisation, OutputStreams created by incremental build
context will attempt to avoid writing to the file if file content
has not changed.newFileOutputStream
in interface BuildContext
IOException
public org.codehaus.plexus.util.Scanner newScanner(File basedir)
BuildContext
newScanner
in interface BuildContext
public org.codehaus.plexus.util.Scanner newScanner(File basedir, boolean ignoreDelta)
BuildContext
basedir
.
If this is an incremental build context and ignoreDelta
is false
, the scanner will only "see" files and folders with
content changes since last build.
If ignoreDelta
is true
, the scanner will "see" all
files and folders.
Please beware that ignoreDelta=false does NOT work reliably for operations
that copy resources from source to target locations. Returned Scanner
only scans changed source resources and it does not consider changed or deleted
target resources. This results in missing or stale target resources.
Starting with 0.5.0, recommended way to process resources is to use
#newScanner(basedir,true) to locate all source resources and BuildContext.isUptodate(File, File)
to optimized processing of uptodate target resources.
Returns empty Scanner if basedir
is not under this build context basedir.newScanner
in interface BuildContext
http://jira.codehaus.org/browse/MSHARED-125
public void refresh(File file)
BuildContext
refresh
in interface BuildContext
BuildContext.newFileOutputStream(File)
public Object getValue(String key)
BuildContext
key
during previous mojo execution.
This method always returns null
for non-incremental builds
(i.e., BuildContext.isIncremental()
returns false
) and mojos are
expected to fall back to full, non-incremental behaviour.getValue
in interface BuildContext
BuildContext.setValue(String, Object)
,
BuildContext.isIncremental()
public boolean isIncremental()
BuildContext
true
if this build context is incremental.
Scanners created by BuildContext.newScanner(File)
of an incremental build context
will ignore files and folders that were not changed since last build.
Additionally, BuildContext.newDeleteScanner(File)
will scan files and directories
deleted since last build.isIncremental
in interface BuildContext
public void setValue(String key, Object value)
BuildContext
key
with specified value
in the build context.
Primary (and the only) purpose of this method is to allow preservation of
state needed for proper incremental behaviour between consecutive executions
of the same mojo needed to.
For example, maven-plugin-plugin:descriptor mojo
can store collection of extracted MojoDescritpor during first invocation. Then
on each consecutive execution maven-plugin-plugin:descriptor will only need
to extract MojoDescriptors for changed files.setValue
in interface BuildContext
BuildContext.getValue(String)
public void addMessage(File file, int line, int column, String message, int severity, Throwable cause)
BuildContext
addMessage
in interface BuildContext
file
- The file or folder with which the message is associated. Should not be null and it is recommended to be
an absolute path.line
- The line number inside the file. Use 1 (not 0) for the first line. Use 0 for unknown/unspecified.column
- The column number inside the file. Use 1 (not 0) for the first column. Use 0 for unknown/unspecified.severity
- The severity of the message: SEVERITY_WARNING or SEVERITY_ERROR.cause
- A Throwable object associated with the message. Can be null.public void removeMessages(File file)
BuildContext
removeMessages
in interface BuildContext
public void addWarning(File file, int line, int column, String message, Throwable cause)
addWarning
in interface BuildContext
public void addError(File file, int line, int column, String message, Throwable cause)
addError
in interface BuildContext
public boolean isUptodate(File target, File source)
BuildContext
isUptodate
in interface BuildContext
Copyright © 2019. All rights reserved.