Interface BackgroundResource (2.16.0)

Version 2.16.0

• 2.58.0 (latest)
• 2.57.0
• 2.55.0
• 2.54.1
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.1
• 2.47.0
• 2.46.1
• 2.45.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.1
• 2.33.0
• 2.32.1
• 2.31.1
• 2.30.1
• 2.24.0
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.1
• 2.19.6
• 2.18.7
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.2
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.1
• 2.7.1

public interface BackgroundResource extends AutoCloseable

Represents a resource running in the background that needs to be shut down for resources to be released.

Implements

AutoCloseable

Methods

awaitTermination(long duration, TimeUnit unit)

public abstract boolean awaitTermination(long duration, TimeUnit unit)

Blocks until all work has completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

isShutdown()

public abstract boolean isShutdown()

Returns true if this background resource has been shut down.

Returns

Type	Description
boolean

isTerminated()

public abstract boolean isTerminated()

Returns true if all work has completed following shut down. Note that isTerminated is never true unless either shutdown or shutdownNow was called first.

Returns

Type	Description
boolean

shutdown()

public abstract void shutdown()

Initiates an orderly shutdown in which previously submitted work is finished, but no new work will be accepted. Invocation has no additional effect if already shut down.

This method does not wait for previously submitted work to complete execution. Use awaitTermination to do that.

shutdownNow()

public abstract void shutdownNow()

Attempts to stop all actively executing work and halts the processing of waiting work.

This method does not wait for actively executing work to terminate. Use awaitTermination to do that.

There are no guarantees beyond best-effort attempts to stop processing actively executing work. For example, typical implementations will cancel via Thread.interrupt(), so any task that fails to respond to interrupts may never terminate.