saker.build Documentation TaskDoc JavaDoc Packages
public interface TaskParameterInformation extends InformationHolder
Provides information about a parameter specific to a task.

Underlying data in this interface can be lazy loaded similarly to ExternalScriptInformationProvider.

Methods
public default Set<String>
Gets the alias names of this parameter.
public default FormattedTextContent
Gets documentational information about this parameter.
public String
Gets the name of the parameter.
public TaskInformation
Gets the task information this parameter corresponds to.
public default TypeInformation
Gets the type information of the parameter.
public default boolean
Gets if the parameter is deprecated.
public default boolean
Gets if the parameter is required to be specified by the user.
public default Set<String> getAliases()
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.
Gets documentational information about this parameter.
The information about the parameter or null if not available or still loading.
public abstract String getParameterName()
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 abstract TaskInformation getTask()
Gets the task information this parameter corresponds to.
The task information.
Gets the type information of the parameter.
The type of the parameter or null if not available or still loading.
public default boolean isDeprecated()
Gets if the parameter is deprecated.
true if the parameter is deprecated.
public default boolean isRequired()
Gets if the parameter is required to be specified by the user.
true if required.