DynamicTasks.TaskQueueingResult (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

brooklyn.util.task
[Java] Class DynamicTasks.TaskQueueingResult

java.lang.Object
  brooklyn.util.task.DynamicTasks.TaskQueueingResult

All Implemented Interfaces:: TaskWrapper

public static class DynamicTasks.TaskQueueingResult

Method Summary
`void`	`andWaitForSuccess()` blocks for the task to be completed
`Task`	`asTask()`
`Task`	`getTask()`
`boolean`	`isQueuedOrSubmitted()` returns true if the task either is currently queued or has been submitted
`TaskQueueingResult`	`orSubmitAndBlock()` causes the task to be submitted synchronously if it hasn't already been submitted; useful in contexts such as libraries where callers may be either on a legacy call path (which assumes all commands complete immediately)
`TaskQueueingResult`	`orSubmitAsync()` causes the task to be submitted (asynchronously) if it hasn't already been
`boolean`	`wasQueued()` returns true if the task was queued

Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()

Method Detail

andWaitForSuccess

public void andWaitForSuccess()

blocks for the task to be completed

needed in any context where subsequent commands assume the task has completed. not needed in a context where the task is simply being built up and queued.

throws if there are any errors

asTask

@Override
public Task asTask()

getTask

@Override
public Task getTask()

isQueuedOrSubmitted

public boolean isQueuedOrSubmitted()

returns true if the task either is currently queued or has been submitted

orSubmitAndBlock

public TaskQueueingResult orSubmitAndBlock()

causes the task to be submitted *synchronously* if it hasn't already been submitted; useful in contexts such as libraries where callers may be either on a legacy call path (which assumes all commands complete immediately)

orSubmitAsync

public TaskQueueingResult orSubmitAsync()

causes the task to be submitted (asynchronously) if it hasn't already been

wasQueued

public boolean wasQueued()

returns true if the task was queued

brooklyn.util.task [Java] Class DynamicTasks.TaskQueueingResult