TaskInformation

package saker.build.scripting.model.info

public interface TaskInformation extends InformationHolder

saker.build.scripting.model.info.TaskInformation

saker.build.scripting.model.info.InformationHolder

Provides information about a specific task implementation.

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

Methods

public default FormattedTextContent	getInformation() Gets documentational information about the task.
public default Collection<? extends TaskParameterInformation>	getParameters() Gets information about the parameters of this task.
public default TypeInformation	getReturnType() Gets the return type information of the task.
public TaskName	getTaskName() Gets the name of the task.
public default boolean	isDeprecated() Gets if the task is deprecated.

public default FormattedTextContent getInformation()

Gets documentational information about the task.

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

public default Collection<? extends TaskParameterInformation> getParameters()

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 default TypeInformation getReturnType()

Gets the return type information of the task.

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

public abstract TaskName getTaskName()

Gets the name of the task.

The task name.

public default boolean isDeprecated()

Gets if the task is deprecated.

true if the task is deprecated.