Package com.google.api.gax.core

Class BaseBackgroundResource

java.lang.Object

com.google.api.gax.core.BaseBackgroundResource

All Implemented Interfaces:

BackgroundResource, AutoCloseable

public class BaseBackgroundResource
extends Object
implements BackgroundResource

A Background resource that does nothing.

Constructor Summary

Constructors

Constructor	Description
BaseBackgroundResource()

Method Summary

Modifier and Type	Method	Description
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.
void	close()
boolean	isShutdown()	Returns true if this background resource has been shut down.
boolean	isTerminated()	Returns true if all work has completed following shut down.
void	shutdown()	Initiates an orderly shutdown in which previously submitted work is finished, but no new work will be accepted.
void	shutdownNow()	Attempts to stop all actively executing work and halts the processing of waiting work.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseBackgroundResource

public BaseBackgroundResource()

Method Detail

shutdown

public void shutdown()

Description copied from interface: BackgroundResource

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.

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Description copied from interface: BackgroundResource

Returns true if this background resource has been shut down.

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Description copied from interface: BackgroundResource

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

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Description copied from interface: BackgroundResource

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.

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Description copied from interface: BackgroundResource

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

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception