NestTaskInformation

package saker.nest.scriptinfo.reflection.annot

public @interface NestTaskInformation

saker.nest.scriptinfo.reflection.annot.NestTaskInformation

java.lang.annotation.Annotation

Annotation to be placed on tasks used with the Nest repository.

Any class that is declared to be contained in a bundle in the task declarations entry file can be annotated with NestTaskInformation. The field(s) in the annotation can be used to specify information about the task.

The annotation NestParameterInformation can be used to specify the parameters which are recognized by the task. See TaskInformation.getParameters().

The annotation NestInformation can be used to provide documentational information about the task. See TaskInformation.getInformation().

The task name of the task will be automatically determined by the repository. See TaskInformation.getTaskName().

The deprecation is determined by checking if the task has the Deprecated annotation as well. See TaskInformation.isDeprecated().

The annotations should be placed on the class that is declared as the task class in the task declarations entry file.

TaskInformation

Methods

public Class<?>[]	includeFieldsAsParametersFrom() default {} Specifies a type from which the fields should be included as parameter informations to the task.
public NestTypeUsage	returnType() default @NestTypeUsage(kind = "OBJECT_LITERAL", value = Object.class) Specifies the return type of the task.

Inherited methods
From: Annotation annotationType, equals, hashCode, toString

public abstract Class<?>[] includeFieldsAsParametersFrom() default {}

Specifies a type from which the fields should be included as parameter informations to the task.

All the fields from the specified classes will be included as parameter informations to the annotated task.

Specifying this can be useful when a task has similar parameters as some other class has fields.

The types to include the field informations from.

NestFieldInformation

NestParameterInformation

public abstract NestTypeUsage returnType() default @NestTypeUsage(kind = "OBJECT_LITERAL", value = Object.class)

Specifies the return type of the task.

The return type.

TaskInformation.getReturnType()