aQute.bnd.ant

Class BaseTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

aQute.bnd.ant.BaseTask

All Implemented Interfaces:

Report, Reporter, Cloneable

Direct Known Subclasses:

BndTask, DeployTask, EclipseTask, ExpandPropertiesTask, PackageTask, PrepareTask, ProjectBuildOrderTask, ProjectTask, ReleaseTask, TestTask, WrapTask

public class BaseTask
extends org.apache.tools.ant.Task
implements Reporter

Nested Class Summary

Nested classes/interfaces inherited from interface aQute.service.reporter.Reporter

Reporter.SetLocation

Nested classes/interfaces inherited from interface aQute.service.reporter.Report

Report.Location

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
BaseTask()

Method Summary

Modifier and Type	Method and Description
void	addProperty(org.apache.tools.ant.taskdefs.Property property)
void	addWsproperty(org.apache.tools.ant.taskdefs.Property property)
Reporter.SetLocation	error(String s, Object... args) Create an error.
Reporter.SetLocation	exception(Throwable t, String format, Object... args) Dedicated message for an exception.
List<String>	getErrors() Return the errors.
static File	getFile(File base, String file)
Report.Location	getLocation(String msg) Return the errors for the given error or warning.
List<String>	getWarnings() Return the warnings.
boolean	isExceptions()
boolean	isOk() Check if this report has any relevant errors that should make the run associated with this report invalid.
boolean	isPedantic() The provider of the reporter wants pedantic reporting, meaning every possible warning should be reported.
boolean	isTrace()
protected String	join(Collection<?> classpath, String string)
void	progress(float progress, String s, Object... args) Create a warning.
protected boolean	report()
protected boolean	report(Reporter reporter)
void	setExceptions(boolean exceptions)
void	setPedantic(boolean pedantic)
void	setTrace(boolean trace)
protected List<String>	split(String dependsOn, String string)
void	trace(String s, Object... args) Create a warning.
Reporter.SetLocation	warning(String s, Object... args) Create a warning.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseTask

public BaseTask()

Method Detail

report

protected boolean report()

report

protected boolean report(Reporter reporter)

getFile

public static File getFile(File base,
                           String file)

split

protected List<String> split(String dependsOn,
                             String string)

join

protected String join(Collection<?> classpath,
                      String string)

isPedantic

public boolean isPedantic()

Description copied from interface: Reporter

The provider of the reporter wants pedantic reporting, meaning every possible warning should be reported.

Specified by:

isPedantic in interface Reporter

Returns:

if this is a pedantic reporter.

setPedantic

public void setPedantic(boolean pedantic)

setTrace

public void setTrace(boolean trace)

isTrace

public boolean isTrace()

trace

public void trace(String s,
                  Object... args)

Description copied from interface: Reporter

Create a warning. Implementations must ensure that the given args are not prevented from garbage collecting. The args must have a proper toString method.

Specified by:

trace in interface Reporter

Parameters:

s - The format of the error

args - The arguments of the error

addProperty

public void addProperty(org.apache.tools.ant.taskdefs.Property property)

addWsproperty

public void addWsproperty(org.apache.tools.ant.taskdefs.Property property)

isExceptions

public boolean isExceptions()

setExceptions

public void setExceptions(boolean exceptions)

getLocation

public Report.Location getLocation(String msg)

Description copied from interface: Report

Return the errors for the given error or warning. Can return null.

Specified by:

getLocation in interface Report

Parameters:

msg - The message

Returns:

null or the location of the message

isOk

public boolean isOk()

Description copied from interface: Report

Check if this report has any relevant errors that should make the run associated with this report invalid. I.e. if this returns false then the run should be disregarded.

Specified by:

isOk in interface Report

Returns:

true if this run should be disregarded due to errors

exception

public Reporter.SetLocation exception(Throwable t,
                                      String format,
                                      Object... args)

Description copied from interface: Reporter

Dedicated message for an exception.

Specified by:

exception in interface Reporter

Parameters:

t - The exception

args - The arguments

error

public Reporter.SetLocation error(String s,
                                  Object... args)

Description copied from interface: Reporter

Create an error. Implementations must ensure that the given args are not prevented from garbage collecting. The args must have a proper toString method.

Specified by:

error in interface Reporter

Parameters:

s - The format of the error

args - The arguments of the error

Returns:

a SetLocation to set the location

getErrors

public List<String> getErrors()

Description copied from interface: Report

Return the errors. This list must not be changed and may be immutable.

Specified by:

getErrors in interface Report

Returns:

the errors

getWarnings

public List<String> getWarnings()

Description copied from interface: Report

Return the warnings. This list must not be changed and may be immutable.

Specified by:

getWarnings in interface Report

Returns:

the warnings

progress

public void progress(float progress,
                     String s,
                     Object... args)

Description copied from interface: Reporter

Create a warning. Implementations must ensure that the given args are not prevented from garbage collecting. The args must have a proper toString method.

Specified by:

progress in interface Reporter

Parameters:

progress - A value between 0 and 1 indicating the progress. 0 is starting and >=1 is done.

s - The format of the error

args - The arguments of the error

warning

public Reporter.SetLocation warning(String s,
                                    Object... args)

Description copied from interface: Reporter

Create a warning. Implementations must ensure that the given args are not prevented from garbage collecting. The args must have a proper toString method.

Specified by:

warning in interface Reporter

Parameters:

s - The format of the error

args - The arguments of the error

Returns:

a SetLocation to set the location