AbstractExecutionThreadService (Guava: Google Core Libraries for Java

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.google.common.util.concurrent
Class AbstractExecutionThreadService

java.lang.Object
  com.google.common.util.concurrent.AbstractExecutionThreadService

All Implemented Interfaces:: Service

@Beta public abstract class AbstractExecutionThreadService
extends Object
implements Service
extends Object
implements Service

Base class for services that can implement startUp(), run() and shutDown() methods. This class uses a single thread to execute the service; consider AbstractService if you would like to manage any threading manually.

Since:: 1
Author:: Jesse Wilson

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.base.Service
`Service.State`

Constructor Summary
`AbstractExecutionThreadService()`

Method Summary
`protected Executor`	`executor()` Returns the `Executor` that will be used to run this service.
`boolean`	`isRunning()` Returns `true` if this service is `running`.
`protected abstract void`	`run()` Run the service.
`protected void`	`shutDown()` Stop the service.
`Future<Service.State>`	`start()` If the service state is `Service.State.NEW`, this initiates service startup and returns immediately.
`Service.State`	`startAndWait()` Initiates service startup (if necessary), returning once the service has finished starting.
`protected void`	`startUp()` Start the service.
`Service.State`	`state()` Returns the lifecycle state of the service.
`Future<Service.State>`	`stop()` If the service is `Service.State.STARTING` or `Service.State.RUNNING`, this initiates service shutdown and returns immediately.
`Service.State`	`stopAndWait()` Initiates service shutdown (if necessary), returning once the service has finished stopping.
`String`	`toString()` Returns a string representation of the object.
`protected void`	`triggerShutdown()` Invoked to request the service to stop.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

AbstractExecutionThreadService

public AbstractExecutionThreadService()

Method Detail

startUp

protected void startUp()
                throws Exception

Start the service. This method is invoked on the execution thread.

Throws:: Exception

run

protected abstract void run()
                     throws Exception

Run the service. This method is invoked on the execution thread. Implementations must respond to stop requests. You could poll for lifecycle changes in a work loop:

   public void run() {
     while (isRunning()) {
       // perform a unit of work
     }
   }

...or you could respond to stop requests by implementing triggerShutdown(), which should cause run() to return.

Throws:: Exception

shutDown

protected void shutDown()
                 throws Exception

Stop the service. This method is invoked on the execution thread.

Throws:: Exception

triggerShutdown

protected void triggerShutdown()

Invoked to request the service to stop.

executor

protected Executor executor()

Returns the Executor that will be used to run this service. Subclasses may override this method to use a custom Executor, which may configure its worker thread with a specific name, thread group or priority. The returned executor's execute() method is called when this service is started, and should return promptly.

toString

public String toString()

Description copied from class: java.lang.Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Overrides:: toString in class Object

Returns:: a string representation of the object.