SimpleTaskInformation

package saker.build.scripting.model.info

public class SimpleTaskInformation implements TaskInformation, Externalizable

saker.build.scripting.model.info.SimpleTaskInformation

java.lang.Object

saker.build.scripting.model.info.TaskInformation

saker.build.scripting.model.info.InformationHolder

java.io.Externalizable

java.io.Serializable

Simple TaskInformation data class.

Constructors

public	SimpleTaskInformation() For Externalizable.
public	SimpleTaskInformation(TaskName taskName) Creates a new instance for the given task name.

Methods

public FormattedTextContent	getInformation() Gets documentational information about the task.
public Collection<? extends TaskParameterInformation>	getParameters() Gets information about the parameters of this task.
public TypeInformation	getReturnType() Gets the return type information of the task.
public TaskName	getTaskName() Gets the name of the task.
public boolean	isDeprecated() Gets if the task is deprecated.
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 void	setDeprecated(boolean deprecated) Sets the deprecated flag for this task.
public void	setInformation(FormattedTextContent information) Sets the documentational information.
public void	setParameters(Collection<? extends TaskParameterInformation> parameters) Sets the parameter informations.
public void	setReturnType(TypeInformation returnType) Sets the return type of the task.
public void	setTaskName(TaskName taskName) Sets the task name.
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 SimpleTaskInformation()

For Externalizable.

public SimpleTaskInformation(TaskName taskName)

Creates a new instance for the given task name.

taskNameThe task name.

getTaskName()

public FormattedTextContent getInformation()

Overridden from: TaskInformation

Gets documentational information about the task.

The information about the task or null if not available or still loading.

public Collection<? extends TaskParameterInformation> getParameters()

Overridden from: TaskInformation

Gets information about the parameters of this task.

Each task can have only one parameter with a specific name. In other words, it is invalid for a task to have multiple parameters with the same name. See TaskParameterInformation.getParameterName().

Collection of parameter informations for this task or null if not available or still loading.

public TypeInformation getReturnType()

Overridden from: TaskInformation

Gets the return type information of the task.

The return type information or null if not available or still loading.

public TaskName getTaskName()

Overridden from: TaskInformation

Gets the name of the task.

The task name.

public boolean isDeprecated()

Overridden from: TaskInformation

Gets if the task is deprecated.

true if the task is deprecated.

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 void setDeprecated(boolean deprecated)

Sets the deprecated flag for this task.

deprecatedtrue if deprecated.

isDeprecated()

public void setInformation(FormattedTextContent information)

Sets the documentational information.

informationThe information.

getInformation()

public void setParameters(Collection<? extends TaskParameterInformation> parameters)

Sets the parameter informations.

parametersThe parameter informations.

getParameters()

public void setReturnType(TypeInformation returnType)

Sets the return type of the task.

returnTypeThe return type.

getReturnType()

public void setTaskName(TaskName taskName)

Sets the task name.

taskNameThe task name.

getTaskName()

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