Pipeline

Instance Constructors

new Pipeline(outputDirectory: Option[Path] = None, prefix: Option[String] = None, suffix: Option[String] = None)

Abstract Value Members

abstract def build(): Unit

Build your pipeline here.
Build your pipeline here. Use ==> to define dependencies between tasks and use root ==> myTask to capture tasks that have no dependencies and can start immediately.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def !=>(other: MultiTask): other.type

Removes this as a dependency for other
Removes this as a dependency for other

Definition Classes
Task → Dependable
def !=>(other: Task): other.type

Removes this as a dependency for other
Removes this as a dependency for other

Definition Classes
Task → Dependable
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from Pipeline to any2stringadd[Pipeline] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Pipeline, B)

Implicit information
This member is added by an implicit conversion from Pipeline to ArrowAssoc[Pipeline] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
def ::(other: Task): MultiTask

Combines this task with another task into a MultiTask.
Combines this task with another task into a MultiTask.

Definition Classes
Task
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def ==>(other: MultiTask): other.type

Creates a dependency on this dependable for all the Tasks in the provided MultiTask.
Creates a dependency on this dependable for all the Tasks in the provided MultiTask.

Definition Classes
Task → Dependable
def ==>(other: Task): other.type

Sets up a dependency between two tasks.
Sets up a dependency between two tasks. The task on the left side of the arrow (i.e. this) is set to be a predecessor/dependency of that task on the right hand side of the arrow (i.e. other).
returns
the "other" task so that chains of calls like a ==> b ==> c work correctly

Definition Classes
Task → Dependable
def addTask(task: Task): task.type

Adds a single task, and returns the added task.
def addTasks(task: Task*): Unit

Add one or more tasks to this pipeline.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def contains(task: Task): Boolean

True if we this pipeline is tracking this direct ancestor task, false otherwise.
def ensuring(cond: (Pipeline) ⇒ Boolean, msg: ⇒ Any): Pipeline

Implicit information
This member is added by an implicit conversion from Pipeline to Ensuring[Pipeline] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Pipeline) ⇒ Boolean): Pipeline

Implicit information
This member is added by an implicit conversion from Pipeline to Ensuring[Pipeline] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Pipeline

Implicit information
This member is added by an implicit conversion from Pipeline to Ensuring[Pipeline] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Pipeline

Implicit information
This member is added by an implicit conversion from Pipeline to Ensuring[Pipeline] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from Pipeline to StringFormat[Pipeline] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def getTasks: Traversable[_ <: Task]

Will call build() and get the tasks.
Will call build() and get the tasks.
returns
the list of tasks of to run.

Definition Classes
Pipeline → Task
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
lazy val logger: Logger

Attributes
protected
Definition Classes
LazyLogging
var name: String

The name of the task.
The name of the task.

Definition Classes
Task
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def onComplete(exitCode: Int): Boolean

Finalize anything after the task has been run.
Finalize anything after the task has been run.
This method should be called after a task has been run. The intended use of this method is to allow for any modification of this task prior to any dependent tasks being run. This would allow any parameters that were passed to dependent tasks as call-by-name to be finalized here. For example, we could have passed an Option[String] that is None until make it Some(String) in this method. Then when the dependent task's getTasks method is called, it can call 'get' on the option and get something.
exitCode
the exit code of the task, which could also be 1 due to the system terminating this process
returns
true if we c

Definition Classes
Task
val outputDirectory: Option[Path]
def removeDependency(task: Task): Boolean

Removes a dependency by removing the supplied task from the list of dependencies for this task and removing this from the list of tasks depending on "task".
Removes a dependency by removing the supplied task from the list of dependencies for this task and removing this from the list of tasks depending on "task".
task
a task on which this task depends
returns
true if a dependency existed and was removed, false otherwise

Definition Classes
Task
def retry(taskInfo: TaskExecutionInfo, failedOnComplete: Boolean): Option[Task]

Retry the given task.
Retry the given task.
taskInfo
the task execution information for the task to be retried.
failedOnComplete
true the task failed while running its onComplete method, otherwise failed while running its command
returns
the task to be retried, None if it is not to be retried.

Definition Classes
Task
val root: Dependable

A name exposed to sub-classes that can be treated like a Task, to add root tasks.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withName(name: String): Pipeline.this.type

Sets the name of this task.
Sets the name of this task.

Definition Classes
Task
def →[B](y: B): (Pipeline, B)

Implicit information
This member is added by an implicit conversion from Pipeline to ArrowAssoc[Pipeline] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Inherited from LazyLogging

Inherited from Task

Inherited from Dependable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Pipeline to any2stringadd[Pipeline]

Inherited by implicit conversion StringFormat from Pipeline to StringFormat[Pipeline]

Inherited by implicit conversion Ensuring from Pipeline to Ensuring[Pipeline]

Inherited by implicit conversion ArrowAssoc from Pipeline to ArrowAssoc[Pipeline]

Ungrouped

Related Doc: package tasksystem

abstract class Pipeline extends Task with LazyLogging

Instance Constructors

new Pipeline(outputDirectory: Option[Path] = None, prefix: Option[String] = None, suffix: Option[String] = None)

Abstract Value Members

abstract def build(): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

def !=>(other: MultiTask): other.type

def !=>(other: Task): other.type

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Pipeline, B)

def ::(other: Task): MultiTask

final def ==(arg0: Any): Boolean

def ==>(other: MultiTask): other.type

def ==>(other: Task): other.type

def addTask(task: Task): task.type

def addTasks(task: Task*): Unit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def contains(task: Task): Boolean

def ensuring(cond: (Pipeline) ⇒ Boolean, msg: ⇒ Any): Pipeline

def ensuring(cond: (Pipeline) ⇒ Boolean): Pipeline

def ensuring(cond: Boolean, msg: ⇒ Any): Pipeline

def ensuring(cond: Boolean): Pipeline

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

final def getTasks: Traversable[_ <: Task]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

lazy val logger: Logger

var name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def onComplete(exitCode: Int): Boolean

val outputDirectory: Option[Path]

def removeDependency(task: Task): Boolean

def retry(taskInfo: TaskExecutionInfo, failedOnComplete: Boolean): Option[Task]

val root: Dependable

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withName(name: String): Pipeline.this.type

def →[B](y: B): (Pipeline, B)

Inherited from LazyLogging

Inherited from Task

Inherited from Dependable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Pipeline to any2stringadd[Pipeline]

Inherited by implicit conversion StringFormat from Pipeline to StringFormat[Pipeline]

Inherited by implicit conversion Ensuring from Pipeline to Ensuring[Pipeline]

Inherited by implicit conversion ArrowAssoc from Pipeline to ArrowAssoc[Pipeline]

Ungrouped