saker.build Documentation TaskDoc JavaDoc Packages
public final class BuildTargetBootstrapperTaskFactory implements TaskFactory<StructuredObjectTaskResult>, Task<StructuredObjectTaskResult>, Externalizable
Bootstrapper task for invoking a build target of a build script with the given parameters.

This task can be used to start a build target with a specific name in a build script. This task handles the dependency management, parsing, and execution of the specified build target.

The static method runBootstrapping(TaskContext, SakerPath, String, NavigableMap<String, ? extends TaskIdentifier>, SakerPath, SakerPath) can be called from other tasks to avoid starting this bootstrapper task and still be able to invoke a build target in the same way. In that case the dependencies will be reported in the caller task.

The task identifier returned by getTaskIdentifier(BuildTargetBootstrapperTaskFactory) should be used when starting an instance of this task factory.

Constructors
public
public
BuildTargetBootstrapperTaskFactory(SakerPath buildFilePath, String buildTargetName, NavigableMap<String, ? extends TaskIdentifier> parameters, SakerPath workingDirectory, SakerPath buildDirectory)
Creates a new instance with the given parameters.
Methods
public Task<extends StructuredObjectTaskResult>
createTask(ExecutionContext executioncontext)
Creates a task instance.
public boolean
Indicates whether some other object is "equal to" this one.
public static TaskIdentifier
Gets the task identifier which should be used when starting an instance of BuildTargetBootstrapperTaskFactory.
public int
Returns a hash code value for the object.
public void
The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
public StructuredObjectTaskResult
run(TaskContext taskcontext)
Executes this task.
public static BuildFileTargetTaskIdentifier
runBootstrapping(TaskContext taskcontext, SakerPath buildFilePath, String buildTargetName, NavigableMap<String, ? extends TaskIdentifier> parameters, SakerPath workingDirectory, SakerPath buildDirectory)
Executes the bootstrapping of a build target task in the given task context.
public String
Returns a string representation of the object.
public void
The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.
public BuildTargetBootstrapperTaskFactory(SakerPath buildFilePath, String buildTargetName, NavigableMap<String, ? extends TaskIdentifier> parameters, SakerPath workingDirectory, SakerPath buildDirectory) throws NullPointerException, InvalidPathFormatException
Creates a new instance with the given parameters.
buildFilePathAn absolute path to the build script.
buildTargetNameThe build target name to invoke. May be null to choose the default.
parametersThe task parameters to pass to the build target. May be null or empty.
workingDirectoryThe absolute working directory for the invoked task. If null, the parent path of the build file is used.
buildDirectoryThe relative build directory path.
NullPointerExceptionIf argument nullability is violated.
InvalidPathFormatExceptionIf path requirements are violated.
public Task<extends StructuredObjectTaskResult> createTask(ExecutionContext executioncontext)
Overridden from: TaskFactory
Creates a task instance.

Every task instance is used for only one invocation.

executioncontextThe execution context that is used to run the task.
The created task.
public boolean equals(Object obj)
Overridden from: Object
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

objthe reference object with which to compare.
true if this object is the same as the obj argument; false otherwise.
Gets the task identifier which should be used when starting an instance of BuildTargetBootstrapperTaskFactory.
taskThe task to get the task identifier for.
The task identifier.
public int hashCode()
Overridden from: Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the Object.equals(Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

a hash code value for this object.
Overridden from: Externalizable
The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.
inthe stream to read data from in order to restore the object
IOExceptionif I/O errors occur
ClassNotFoundExceptionIf the class for an object being restored cannot be found.
Overridden from: Task
Executes this task.

If this task is an intance of ParameterizableTask, then ParameterizableTask.initParameters(TaskContext, NavigableMap<String, ? extends TaskIdentifier>) will be called prior to this.

This method is called at most once during the lifetime of the task object.

taskcontextThe task context to communicate with the build system.
The result of this task, may be an instance of StructuredTaskResult or any arbitrary object.
ExceptionFor any exception that caused this task to fail.
public static BuildFileTargetTaskIdentifier runBootstrapping(TaskContext taskcontext, SakerPath buildFilePath, String buildTargetName, NavigableMap<String, ? extends TaskIdentifier> parameters, SakerPath workingDirectory, SakerPath buildDirectory) throws InvalidPathFormatException, Exception
Executes the bootstrapping of a build target task in the given task context.

Dependencies will be reported for the build script, and script parsing options.

taskcontextThe task context.
buildFilePathThe path to the build file. Relative paths are resolved against the working directory of the task context.
buildTargetNameThe name of the build target to invoke or null to choose the default.
parametersThe task parameters to invoke the build target with.
workingDirectoryThe working directory. If null, the parent path of the build file is used.
buildDirectoryA relative path to the build directory to use for the invoked task. It is relative to the execution build directory.
The task identifier of the started build target task.
InvalidPathFormatExceptionIf path requirements are violated.
ExceptionIf the build target bootstrapping fails.
public String toString()
Overridden from: Object
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 
a string representation of the object.
public void writeExternal(ObjectOutput out) throws IOException
Overridden from: Externalizable
The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.
outthe stream to write the object to
IOExceptionIncludes any I/O exceptions that may occur