TaskLaunchArguments

public class TaskLaunchArguments<R> implements Externalizable

saker.build.task.TaskLaunchArguments<R>

java.lang.Object

java.io.Externalizable

java.io.Serializable

Simple data class aggregating the information necessary for starting a task in the build system.

This class is most likely used via the TaskExecutionUtilities for the current task execution. Using this class, the task can start multiple subtasks in a batch (i.e. with a single call) which can increase performance when designing tasks for remote execution.

RThe result type of the started task.

TaskContext.startTask(TaskIdentifier, TaskFactory<R>, TaskExecutionParameters)

TaskExecutionUtilities

Constructors

public	TaskLaunchArguments() For Externalizable.
public	TaskLaunchArguments(TaskIdentifier taskIdentifier, TaskFactory<R> taskFactory) Creates a new instance with the given arguments.
public	TaskLaunchArguments(TaskIdentifier taskIdentifier, TaskFactory<R> taskFactory, TaskExecutionParameters executionParameters) Creates a new instance with the given arguments.

Methods

public TaskExecutionParameters	getExecutionParameters() Gets the execution parameters used to start the task.
public TaskFactory<R>	getTaskFactory() Gets the started task factory.
public TaskIdentifier	getTaskIdentifier() Gets the task identifier of the started task.
public void	readExternal(ObjectInput in) 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 String	toString() Returns a string representation of the object.
public void	writeExternal(ObjectOutput out) 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.

Inherited methods
From: Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

public TaskLaunchArguments()

For Externalizable.

public TaskLaunchArguments(TaskIdentifier taskIdentifier, TaskFactory<R> taskFactory) throws NullPointerException

Creates a new instance with the given arguments.

The execution parameters is initialized to null.

taskIdentifierThe identifier for the started task.

taskFactoryThe task factory to start.

NullPointerExceptionIf the task identifier or task factory is null.

public TaskLaunchArguments(TaskIdentifier taskIdentifier, TaskFactory<R> taskFactory, TaskExecutionParameters executionParameters) throws NullPointerException

Creates a new instance with the given arguments.

taskIdentifierThe identifier for the started task.

taskFactoryThe task factory to start.

executionParametersThe execution parameters for the started task of null.

NullPointerExceptionIf the task identifier or task factory is null.

public TaskExecutionParameters getExecutionParameters()

Gets the execution parameters used to start the task.

The execution parameters or null if unset.

public TaskFactory<R> getTaskFactory()

Gets the started task factory.

The task factory.

public TaskIdentifier getTaskIdentifier()

Gets the task identifier of the started task.

The task identifier.

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

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.

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