Task (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | METHOD

DETAIL: FIELD | METHOD

brooklyn.management
[Java] Interface Task

brooklyn.management.TaskStub
  brooklyn.management.Task

All Superinterfaces:: TaskStub

public interface Task
extends java.util.concurrent.Future, TaskStub

Represents a unit of work for execution. When used with an ExecutionManager or ExecutionContext it will record submission time, execution start time, end time, and any result. A task can be submitted to the ExecutionManager or ExecutionContext, in which case it will be returned, or it may be created by submission of a java.lang.Runnable or Callable and thereafter it can be treated just like a java.util.concurrent.Future.

Method Summary
`void`	`blockUntilEnded()` Causes calling thread to block until the task is ended.
`void`	`blockUntilStarted()` Causes calling thread to block until the task is started.
`java.lang.String`	`getDescription()`
`java.lang.String`	`getDisplayName()`
`long`	`getEndTimeUtc()`
`long`	`getStartTimeUtc()`
`java.lang.String`	`getStatusDetail(boolean multiline)` Returns detailed status, suitable for a hover.
`java.lang.String`	`getStatusSummary()`
`long`	`getSubmitTimeUtc()`
`Task`	`getSubmittedByTask()` task which submitted this task, if was submitted by a task
`java.util.Set`	`getTags()`
`java.lang.Thread`	`getThread()` The thread where the task is running, if it is running.
`boolean`	`isBegun()` Whether task has started running.
`boolean`	`isError()` Whether the task threw an error, including cancellation (implies isDone())
`boolean`	`isSubmitted()` Whether task has been submitted

Methods inherited from interface java.util.concurrent.Future
java.util.concurrent.Future#get(), java.util.concurrent.Future#get(long, java.util.concurrent.TimeUnit), java.util.concurrent.Future#cancel(boolean), java.util.concurrent.Future#isCancelled(), java.util.concurrent.Future#isDone()

Methods inherited from interface TaskStub
getId

Method Detail

blockUntilEnded

public void blockUntilEnded()

Causes calling thread to block until the task is ended. Either normally or by cancellation or error, but without throwing error on cancellation or error. (Errors are logged at debug.)

blockUntilStarted

public void blockUntilStarted()

Causes calling thread to block until the task is started.

getDescription

public java.lang.String getDescription()

getDisplayName

public java.lang.String getDisplayName()

getEndTimeUtc

public long getEndTimeUtc()

getStartTimeUtc

public long getStartTimeUtc()

getStatusDetail

public java.lang.String getStatusDetail(boolean multiline)

Returns detailed status, suitable for a hover. Plain-text format, with new-lines (and sometimes extra info) if multiline enabled.

getStatusSummary

public java.lang.String getStatusSummary()

getSubmitTimeUtc

public long getSubmitTimeUtc()

getSubmittedByTask

public Task getSubmittedByTask()

task which submitted this task, if was submitted by a task

getTags

public java.util.Set getTags()

getThread

public java.lang.Thread getThread()

The thread where the task is running, if it is running.

isBegun

public boolean isBegun()

Whether task has started running. Will remain true after normal completion or non-cancellation error. will be true on cancel iff the thread did actually start.

isError

public boolean isError()

Whether the task threw an error, including cancellation (implies isDone())

isSubmitted

public boolean isSubmitted()

Whether task has been submitted Submitted tasks are normally expected to start running then complete, but unsubmitted tasks are sometimes passed around for someone else to submit them.

brooklyn.management [Java] Interface Task