Trait/Object

dagr.core.tasksystem

Task

Related Docs: object Task | package tasksystem

Permalink

trait Task extends Dependable

Base class for all tasks, multi-tasks, and workflows.

Once a task is constructed, it has the following evolution: 1. Any tasks on which it depends are added (see ==>). 2. When all tasks on which it is dependent have completed, the getTasks method is called to create a set of tasks. This task becomes dependent on any task that is returned that is not itself. 3. When all newly dependent tasks from #2 are complete, as well as this task, the onComplete method is called to perform any light-weight modification of this task. 4. If a task failed during execution or within onComplete, the retry method will be called until the task no longer wishes to retry or succeeds.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Task
  2. Dependable
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def getTasks: Traversable[_ <: Task]

    Permalink

    Get the list of tasks to execute.

    Get the list of tasks to execute.

    All tasks, multi-tasks, workflows, and other task-like-entities should implement this method. In the execution graph, the returned tasks are all children, but not necessarily leaves, meaning the returned tasks themselves may spawn tasks. This task could also generate a mutated or modified task different from this task. It is perfectly reasonable for tasks in the returned list to be themselves be interdependent, but they should not be dependent on tasks not within this list.

    returns

    the list of tasks of to run.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. def !=>(other: Dependable): Unit

    Permalink

    Removes this as a dependency for other

    Removes this as a dependency for other

    Definition Classes
    TaskDependable
  3. final def ##(): Int

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

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

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

    Permalink

    Returns an object that can be used to manage dependencies that apply to this and the other Dependable.

    Returns an object that can be used to manage dependencies that apply to this and the other Dependable.

    Definition Classes
    Dependable
  7. def ::(other: Dependable): Dependable

    Permalink

    Returns an object that can be used to manage dependencies that apply to this and the other Dependable.

    Returns an object that can be used to manage dependencies that apply to this and the other Dependable.

    Definition Classes
    Dependable
  8. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. final def ==>(other: Option[Dependable]): Dependable

    Permalink

    Optionally creates a dependency between this dependable and another dependable if one is provided.

    Optionally creates a dependency between this dependable and another dependable if one is provided.

    Definition Classes
    Dependable
  10. final def ==>(other: Dependable): Dependable

    Permalink

    Creates a dependency on this dependable, for the provided Task.

    Creates a dependency on this dependable, for the provided Task.

    Definition Classes
    Dependable
  11. def addDependent(dependent: Dependable): Unit

    Permalink

    Must be implemented to handle the addition of a dependent.

    Must be implemented to handle the addition of a dependent.

    Definition Classes
    TaskDependable
  12. def allTasks: Traversable[Task]

    Permalink

    Must be implemented to return all tasks represented by the Dependable.

    Must be implemented to return all tasks represented by the Dependable.

    Definition Classes
    TaskDependable
  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. def ensuring(cond: (Task) ⇒ Boolean, msg: ⇒ Any): Task

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  21. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  24. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  25. def headTasks: Traversable[Task]

    Permalink

    Must be implemented to return all tasks on which new predecessor dependencies should be added.

    Must be implemented to return all tasks on which new predecessor dependencies should be added.

    Definition Classes
    TaskDependable
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. var name: String

    Permalink

    The name of the task.

  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. def onComplete(exitCode: Int): Boolean

    Permalink

    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

  32. def removeDependency(task: Task): Boolean

    Permalink

    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

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

    Permalink
    Definition Classes
    AnyRef
  34. def tailTasks: Traversable[Task]

    Permalink

    Must be implemented to return all tasks on which new successor dependencies should be added.

    Must be implemented to return all tasks on which new successor dependencies should be added.

    Definition Classes
    TaskDependable
  35. def tasksDependedOn: Traversable[Task]

    Permalink

    Gets the sequence of tasks that this task depends on..

    Gets the sequence of tasks that this task depends on..

    Attributes
    protected[dagr.core]
  36. def tasksDependingOnThisTask: Traversable[Task]

    Permalink

    Gets the sequence of tasks that depend on this task.

    Gets the sequence of tasks that depend on this task.

    Attributes
    protected[dagr.core]
  37. def toString(): String

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

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

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

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

    Permalink

    Sets the name of this task.

  42. def [B](y: B): (Task, B)

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

Inherited from Dependable

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped