index.md

subkt / myaa.subkt.tasks / PropertyTask

PropertyTask

abstract class PropertyTask : DefaultTask, SubTask (source)

Parent task type that automatically keeps track of and stores properties in JSON format.

Make use of by declaring a delegated property which delegates to a TaskProperty instance.

Types

Name	Summary
TaskProperty	inner class TaskProperty<T : Any> Delegate for reading properties from a JSON file associated with this task.

Constructors

Name	Summary
<init>	PropertyTask() Parent task type that automatically keeps track of and stores properties in JSON format.

Properties

Name	Summary
propertyFile	val propertyFile: File

Functions

Name	Summary
doTask	fun doTask(): Unit
run	abstract fun run(): Unit

Inherited Functions

Name	Summary
batchItems	open fun <T> ItemGroup<T>.batchItems(): List<T> Gets the items from the given item group that correspond to episodes.
item	open fun <T> ItemGroup<T>.item(): T Gets the item from the given item group that corresponds to entry.

Extension Properties

Name	Summary
batch	val Task.batch: String The same as entry if this is a batch task; error otherwise.
currentTask	val Task.currentTask: String The name of this task.
entry	val Task.entry: String The entry (batch or episode) this task corresponds to.
episode	val Task.episode: String The same as entry if this is an episode task; error otherwise.
episodes	val Task.episodes: List<String> The episodes this task corresponds to. A single-item list containing episode if this is an episode task; a list of the episodes for the batch given by batch otherwise.
isBatch	val Task.isBatch: Boolean True if this task is a batch task.
release	val Task.release: String The release this task was generated for.
taskGroup	val <T : Task> T.taskGroup: TaskGroup<T> The TaskGroup instance this task belongs to.

Extension Functions

Name	Summary
defaultProperty	fun <T> Task.defaultProperty(default: T): Property<T> Returns a Property with a default value set.
evaluate	fun Task.evaluate(expression: String): Provider<List<String>!>! Evaluates a string using Velocity, splits it on `
evaluateTemplate	fun Task.evaluateTemplate(expression: String): Provider<String!>! Like evaluate but only processes the template syntax, without globbing.
get	fun Task.get(propertyName: String): Provider<String!>! Searches for the given property in the Subs object's SubProperties instance, evaluates its value using evaluate, and returns a single string, assuming that the resulting list contains only one element.
getAs	fun <T> Task.getAs(propertyName: String): Provider<T>! Searches for the given property in the Subs object's SubProperties instance, evaluates its value using evaluate, and returns a single string, cast to the given type using String.asType, assuming that the resulting list contains only one element.
getFile	fun Task.getFile(filename: String): Provider<String!>! fun Task.getFile(filename: Provider<String>): Provider<String!>! Reads the specified file and processes it using Velocity.
getList	fun Task.getList(propertyName: String): Provider<List<String>> Searches for the given property in the Subs object's SubProperties instance, and evaluates its value using evaluate.
getListAs	fun <T> Task.getListAs(propertyName: String): Provider<List<T>!>! Searches for the given property in the Subs object's SubProperties instance, evaluates its value using evaluate, and casts the list elements to the given type using String.asType.
getRaw	fun Task.getRaw(propertyName: String): String Searches for the given property in the Subs object's SubProperties instance, and returns the raw string. Raises an error if not found.
getRawMaybe	fun Task.getRawMaybe(propertyName: String): String? Searches for the given property in the Subs object's SubProperties instance, and returns the raw string, possibly null.
outputFile	fun Task.outputFile(extension: String): ConfigurableFileCollection Returns a ConfigurableFileCollection containing a single file taskName.extension located in the build directory.
propertyExists	fun Task.propertyExists(propertyName: String): Boolean Returns true if the given property exists in the Subs object's SubProperties instance for the given context.

Inheritors

Name	Summary
Anidex	open class Anidex : PropertyTask Task for uploading a torrent file to anidex.info. A predefined task instance can be accessed through Subs.anidex.
ASSTask	abstract class ASSTask : PropertyTask Represents a task that outputs an ASS file.
Chapters	open class Chapters : PropertyTask Generates a chapter file from an ASS file in the same way as Significance. The provided ASS file will be searched for lines where the field specified by field contains the value specified by chapterMarker, and for each such line a chapter will be generated using the start time as the time, and the value of the field specified by chapterName as the chapter name. A predefined task instance can be accessed through Subs.chapters.
HTTP	open class HTTP : PropertyTask, SubTask Task for sending general HTTP requests. Data should be sent using one of json, body and form. The response can be retrieved from responseData or responseJson.
Mux	open class Mux : PropertyTask Task to mux a set of files into a single Matroska container using mkvmerge.
Nyaa	open class Nyaa : PropertyTask Task for uploading a torrent file to nyaa.si. A predefined task instance can be accessed through Subs.nyaa.