com.thegoate.staff.GoateTask Maven / Gradle / Ivy
/*
* Copyright (c) 2017. Eric Angeli
*
* Permission is hereby granted, free of charge,
* to any person obtaining a copy of this software
* and associated documentation files (the "Software"),
* to deal in the Software without restriction,
* including without limitation the rights to use, copy,
* modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission
* notice shall be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
* AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
package com.thegoate.staff;
import com.thegoate.annotations.GoateDescription;
import com.thegoate.info.Info;
import org.atteo.classindex.IndexAnnotated;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* Use to define a task a particular method does.
* This adds an additional way to define behavior.
* In order to pass parameters into the method, they must be declared in order in the task
* definition using ${var} to represent the parameter. The reference name is how the value
* When defining a usage then "var" inside ${var} should be replaced with the actual name
* of the variable stored in the Goate collection to be used.
* for the parameter should be referenced in the data loaded from the provider.
* example:
* {@literal @}GoateTask(task = "Add ${var} and ${var}")
* public int add(int first, int second){return first+second;}
*
* Created by gtque on 4/21/2017.
*/
@Retention(RetentionPolicy.RUNTIME)
@GoateDescription(description = "Identifies a method as a task that can be executed by the goate framework.")
@Info(classifier = "task")
@IndexAnnotated
public @interface GoateTask {
String task();
}