kotlinx.coroutines.experimental

Class NonCancellable

kotlinx.coroutines.experimental.NonCancellable

All Implemented Interfaces:

Job

public class NonCancellable
implements Job

A non-cancelable job that is always NonCancellable.isActive. It is designed for BuildersKt.withContext function to prevent cancellation of code blocks that need to be executed without cancellation.

Use it like this:

withContext(NonCancellable) {
    // this code will not be cancelled
}

See Also:

NonCancellable.isActive, BuildersKt.withContext

Nested Class Summary

Nested classes/interfaces inherited from interface kotlinx.coroutines.experimental.Job

Job.DefaultImpls, Job.Key

Field Summary

Fields

Modifier and Type	Field and Description
static NonCancellable	INSTANCE A non-cancelable job that is always NonCancellable.isActive. It is designed for BuildersKt.withContext function to prevent cancellation of code blocks that need to be executed without cancellation.

Fields inherited from interface kotlinx.coroutines.experimental.Job

Key

Method Summary

Modifier and Type	Method and Description
DisposableHandle	attachChild(Job child) Always returns class NonDisposableHandle and does not do anything.
boolean	cancel(java.lang.Throwable cause) Always returns false.
java.util.concurrent.CancellationException	getCancellationException() Always throws IllegalStateException.
kotlin.sequences.Sequence<kotlinx.coroutines.experimental.Job>	getChildren() Always returns emptySequence.
SelectClause0	getOnJoin() Clause for select expression of NonCancellable.join suspending function that selects when the job is complete. This clause never fails, even if the job completes exceptionally.
DisposableHandle	invokeOnCompletion(kotlin.jvm.functions.Function1<? super java.lang.Throwable,kotlin.Unit> handler) Always returns class NonDisposableHandle.
DisposableHandle	invokeOnCompletion(boolean onCancelling_, kotlin.jvm.functions.Function1<? super java.lang.Throwable,kotlin.Unit> handler) Always returns class NonDisposableHandle.
DisposableHandle	invokeOnCompletion(boolean onCancelling, boolean invokeImmediately, kotlin.jvm.functions.Function1<? super java.lang.Throwable,kotlin.Unit> handler) Always returns class NonDisposableHandle.
boolean	isActive() Always returns true.
boolean	isCancelled() Always returns false.
boolean	isCompleted() Always returns false.
java.lang.Object	join(kotlin.coroutines.experimental.Continuation<? super kotlin.Unit> p) Always throws UnsupportedOperationException.
boolean	start() Always returns false.

Methods inherited from interface kotlinx.coroutines.experimental.Job

cancel, getCancellationException, getChildren, getOnJoin, invokeOnCompletion, invokeOnCompletion, isActive, isCancelled, isCompleted, join, start

Field Detail

INSTANCE

public static NonCancellable INSTANCE

A non-cancelable job that is always NonCancellable.isActive. It is designed for BuildersKt.withContext function to prevent cancellation of code blocks that need to be executed without cancellation.

Use it like this:

withContext(NonCancellable) {
    // this code will not be cancelled
}

See Also:

NonCancellable.isActive, BuildersKt.withContext

Method Detail

isActive

public boolean isActive()

Always returns true.

isCompleted

public boolean isCompleted()

Always returns false.

isCancelled

public boolean isCancelled()

Always returns false.

start

public boolean start()

Always returns false.

join

public java.lang.Object join(kotlin.coroutines.experimental.Continuation<? super kotlin.Unit> p)

Always throws UnsupportedOperationException.

See Also:

UnsupportedOperationException

getOnJoin

public SelectClause0 getOnJoin()

Clause for select expression of NonCancellable.join suspending function that selects when the job is complete. This clause never fails, even if the job completes exceptionally.

See Also:

NonCancellable.join

getCancellationException

public java.util.concurrent.CancellationException getCancellationException()

Always throws IllegalStateException.

See Also:

IllegalStateException

invokeOnCompletion

public DisposableHandle invokeOnCompletion(kotlin.jvm.functions.Function1<? super java.lang.Throwable,kotlin.Unit> handler)

Always returns class NonDisposableHandle.

See Also:

class NonDisposableHandle

invokeOnCompletion

public DisposableHandle invokeOnCompletion(boolean onCancelling_,
                                           kotlin.jvm.functions.Function1<? super java.lang.Throwable,kotlin.Unit> handler)

Always returns class NonDisposableHandle.

See Also:

class NonDisposableHandle

invokeOnCompletion

public DisposableHandle invokeOnCompletion(boolean onCancelling,
                                           boolean invokeImmediately,
                                           kotlin.jvm.functions.Function1<? super java.lang.Throwable,kotlin.Unit> handler)

Always returns class NonDisposableHandle.

See Also:

class NonDisposableHandle

cancel

public boolean cancel(java.lang.Throwable cause)

Always returns false.

getChildren

public kotlin.sequences.Sequence<kotlinx.coroutines.experimental.Job> getChildren()

Always returns emptySequence.

See Also:

emptySequence

attachChild

public DisposableHandle attachChild(Job child)

Always returns class NonDisposableHandle and does not do anything.

See Also:

class NonDisposableHandle