public class TaskConfigurationChecker
extends java.lang.Object
Helper class for the check of the configuration of a given task. This class provides methods for making assumptions about the task configuration. After collecting all violations with assert* and fail methods the checkErrors will throw a BuildException with all collected messages or does nothing if there wasn't any error.
Example:
public class MyTask extends Task {
...
public void execute() {
TaskConfigurationChecker checker = TaskConfigurationChecker(this);
checker.assertConfig(
srcdir != null,
"Attribute 'srcdir' must be set.
);
checker.assertConfig(
srcdir.exists(),
"Srcdir (" + srcdir + ") must exist."
);
if (someComplexCondition()) {
fail("Complex condition failed.");
}
checker.checkErrors();
}
}
| Constructor | Description |
|---|---|
TaskConfigurationChecker(Task task) |
Constructor.
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
assertConfig(boolean condition,
java.lang.String errormessage) |
Asserts that a condition is true.
|
void |
checkErrors() |
Checks if there are any collected errors and throws a BuildException
with all messages if there was one or more.
|
void |
fail(java.lang.String errormessage) |
Registers an error.
|
public TaskConfigurationChecker(Task task)
task - which task should be checkedpublic void assertConfig(boolean condition,
java.lang.String errormessage)
condition - which condition to checkerrormessage - errormessage to throw if a condition failedpublic void fail(java.lang.String errormessage)
errormessage - the message for the registered errorpublic void checkErrors()
throws BuildException
BuildException - if one or more errors were registered