TaskQueueingContext (Apache Brooklyn)

All Known Implementing Classes:

DynamicSequentialTask
```
@Beta
public interface TaskQueueingContext
```
Marks a place where tasks can be added, e.g. a task which allows children to be added (including after it is activated); if the implementer of this is also a task, then it may be picked up by hierarchical methods (e.g. in DynamicTasks).

Since:

0.6.0

Method Summary

Methods
Modifier and Type	Method and Description
`Task<?>`	`asTask()` Returns the task which is this queueing context
`void`	`drain(Duration optionalTimeout, boolean includePrimaryThread, boolean throwFirstError)` Drains the task queue for this context to complete, ie waits for this context to complete (or terminate early)
`java.util.List<Task<?>>`	`getQueue()` returns a list of queued tasks (immutable copy)
`Task<?>`	`last()` Deprecated. since 0.7.0 this method is misleading if the caller attempts to block on the task and the queue aborts
`void`	`queue(Task<?> t)` queues the task for submission as part of this queueing context
`void`	`swallowChildrenFailures()` causes subsequent children failures not to fail the parent

- Method Detail
  - queue
```
void queue(Task<?> t)
```
    queues the task for submission as part of this queueing context
    implementations should mark it as queued but not yet submitted. note the task may have already been submitted, and is being queued here for informational purposes, in which case the implementation should not run it.
  - getQueue
```
java.util.List<Task<?>> getQueue()
```
    returns a list of queued tasks (immutable copy)
  - last
```
@Deprecated
Task<?> last()
```
    Deprecated. since 0.7.0 this method is misleading if the caller attempts to block on the task and the queue aborts
    
    returns the last task in the queue, or null if none
  - drain
```
void drain(Duration optionalTimeout,
         boolean includePrimaryThread,
         boolean throwFirstError)
```
    Drains the task queue for this context to complete, ie waits for this context to complete (or terminate early)
    
    Parameters:
    optionalTimeout - null to run forever
    includePrimaryThread - whether the parent (this context) should also be joined on; should only be true if invoking this from another task, as otherwise it will be waiting for itself!
    throwFirstError - whether to throw the first exception encountered
    Also note that this waits on tasks so that blocking details on the caller are meaningful.
  - asTask
```
Task<?> asTask()
```
    Returns the task which is this queueing context
  - swallowChildrenFailures
```
void swallowChildrenFailures()
```
    causes subsequent children failures not to fail the parent

Interface TaskQueueingContext

Method Summary

Method Detail

queue

getQueue

last

drain

asTask

swallowChildrenFailures