SimpleTaskParameterInformation

package saker.build.scripting.model.info

public class SimpleTaskParameterInformation implements TaskParameterInformation, Externalizable

saker.build.scripting.model.info.SimpleTaskParameterInformation

java.lang.Object

saker.build.scripting.model.info.TaskParameterInformation

saker.build.scripting.model.info.InformationHolder

java.io.Externalizable

java.io.Serializable

Simple TaskParameterInformation data class.

Constructors

public	SimpleTaskParameterInformation() For Externalizable.
public	SimpleTaskParameterInformation(TaskInformation task, String name) Creates a new instance with the given parameters.

Methods

public Set<String>	getAliases() Gets the alias names of this parameter.
public FormattedTextContent	getInformation() Gets documentational information about this parameter.
public String	getParameterName() Gets the name of the parameter.
public TaskInformation	getTask() Gets the task information this parameter corresponds to.
public TypeInformation	getTypeInformation() Gets the type information of the parameter.
public boolean	isDeprecated() Gets if the parameter is deprecated.
public boolean	isRequired() Gets if the parameter is required to be specified by the user.
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	setAliases(Set<String> aliases) Sets the name aliases.
public void	setDeprecated(boolean deprecated) Sets the deprecated flag for this parameter.
public void	setInformation(FormattedTextContent information) Sets the documentational information.
public void	setParameterName(String name) Sets the parameter name.
public void	setRequired(boolean required) Sets the required flag.
public void	setTypeInformation(TypeInformation typeInformation) Sets the type information.
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 SimpleTaskParameterInformation()

For Externalizable.

public SimpleTaskParameterInformation(TaskInformation task, String name)

Creates a new instance with the given parameters.

taskThe task this parameter corresponds to.

nameThe name of the parameter.

getParameterName()

getTask()

public Set<String> getAliases()

Overridden from: TaskParameterInformation

Gets the alias names of this parameter.

Alias names mean that a parameter can be specified using multiple names, the task implementation will handle that appropriately.

The name aliases or null if not available or still loading.

public FormattedTextContent getInformation()

Overridden from: TaskParameterInformation

Gets documentational information about this parameter.

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

public String getParameterName()

Overridden from: TaskParameterInformation

Gets the name of the parameter.

A specific value "*" means that the parameter doesn't have an explicit name, but will handle arbitrarily named parameters.

The name of the parameter or "*" if the parameter is not explicitly named.

public TaskInformation getTask()

Overridden from: TaskParameterInformation

Gets the task information this parameter corresponds to.

The task information.

public TypeInformation getTypeInformation()

Overridden from: TaskParameterInformation

Gets the type information of the parameter.

The type of the parameter or null if not available or still loading.

public boolean isDeprecated()

Overridden from: TaskParameterInformation

Gets if the parameter is deprecated.

true if the parameter is deprecated.

public boolean isRequired()

Overridden from: TaskParameterInformation

Gets if the parameter is required to be specified by the user.

true if required.

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 setAliases(Set<String> aliases)

Sets the name aliases.

aliasesThe aliases.

getAliases()

public void setDeprecated(boolean deprecated)

Sets the deprecated flag for this parameter.

deprecatedtrue if deprecated.

isDeprecated()

public void setInformation(FormattedTextContent information)

Sets the documentational information.

informationThe information.

getInformation()

public void setParameterName(String name)

Sets the parameter name.

nameThe parameter name.

getParameterName()

public void setRequired(boolean required)

Sets the required flag.

requiredWhether the parameter is required.

isRequired()

public void setTypeInformation(TypeInformation typeInformation)

Sets the type information.

typeInformationThe type information.

getTypeInformation()

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