Interface BackgroundResource (2.36.0)

  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
unit
Returns
Type
Description
Exceptions
Type
Description

isShutdown()

  public 
  
 abstract 
  
 boolean 
  
 isShutdown 
 () 
 

Returns true if this background resource has been shut down.

Returns
Type
Description

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

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.

Create a Mobile Website
View Site in Mobile | Classic
Share by: