Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	AbstractService.HasReachedRunningGuard
private class	AbstractService.IsStartableGuard
private class	AbstractService.IsStoppableGuard
private class	AbstractService.IsStoppedGuard
private static class	AbstractService.StateSnapshot An immutable snapshot of the current state of the service.

Field Summary

Modifier and Type	Field and Description
private final Monitor.Guard	hasReachedRunning
private final Monitor.Guard	isStartable
private final Monitor.Guard	isStoppable
private final Monitor.Guard	isStopped
private final ListenerCallQueue<Service.Listener>	listeners The listeners to notify during a state transition.
private final Monitor	monitor
private static final ListenerCallQueue.Event<Service.Listener>	RUNNING_EVENT
private volatile AbstractService.StateSnapshot	snapshot The current state of the service.
private static final ListenerCallQueue.Event<Service.Listener>	STARTING_EVENT
private static final ListenerCallQueue.Event<Service.Listener>	STOPPING_FROM_RUNNING_EVENT
private static final ListenerCallQueue.Event<Service.Listener>	STOPPING_FROM_STARTING_EVENT
private static final ListenerCallQueue.Event<Service.Listener>	TERMINATED_FROM_NEW_EVENT
private static final ListenerCallQueue.Event<Service.Listener>	TERMINATED_FROM_RUNNING_EVENT
private static final ListenerCallQueue.Event<Service.Listener>	TERMINATED_FROM_STARTING_EVENT
private static final ListenerCallQueue.Event<Service.Listener>	TERMINATED_FROM_STOPPING_EVENT

Constructor Summary

Access	Constructor and Description
protected	AbstractService() Constructor for use by subclasses.

Method Summary

Modifier and Type	Method and Description
public final void	addListener(Service.Listener the listener to run when the service changes state is complete listener, Executor the executor in which the listeners callback methods will be run. For fast, lightweight listeners that would be safe to execute in any thread, consider `MoreExecutors#directExecutor`. executor) Implements com.google.common.util.concurrent.Service.addListener. Registers a `Listener` to be executed on the given executor.
public final void	awaitRunning() Implements com.google.common.util.concurrent.Service.awaitRunning. Waits for the `Service` to reach the running state.
public final void	awaitRunning(Duration the maximum time to wait timeout) Overrides default com.google.common.util.concurrent.Service.awaitRunning. Waits for the `Service` to reach the running state for no more than the given time.
public final void	awaitRunning(long the maximum time to wait timeout, TimeUnit the time unit of the timeout argument unit) Implements com.google.common.util.concurrent.Service.awaitRunning. Waits for the `Service` to reach the running state for no more than the given time.
public final void	awaitTerminated() Implements com.google.common.util.concurrent.Service.awaitTerminated. Waits for the `Service` to reach the terminated state.
public final void	awaitTerminated(Duration the maximum time to wait timeout) Overrides default com.google.common.util.concurrent.Service.awaitTerminated. Waits for the `Service` to reach a terminal state (either `terminated` or `failed`) for no more than the given time.
public final void	awaitTerminated(long the maximum time to wait timeout, TimeUnit the time unit of the timeout argument unit) Implements com.google.common.util.concurrent.Service.awaitTerminated. Waits for the `Service` to reach a terminal state (either `terminated` or `failed`) for no more than the given time.
private void	checkCurrentState(Service.State expected) Checks that the current state is equal to the expected state.
private void	dispatchListenerEvents() Attempts to execute all the listeners in `listeners` while not holding the `monitor`.
protected void	doCancelStart() This method is called by `stopAsync` when the service is still starting (i.e. `startAsync` has been called but `notifyStarted` has not).
protected abstract void	doStart() This method is called by `startAsync` to initiate service startup.
protected abstract void	doStop() This method should be used to initiate service shutdown.
private void	enqueueFailedEvent(final Service.State from, final Throwable cause)
private void	enqueueRunningEvent()
private void	enqueueStartingEvent()
private void	enqueueStoppingEvent(final Service.State from)
private void	enqueueTerminatedEvent(final Service.State from)
public final Throwable	failureCause() Implements com.google.common.util.concurrent.Service.failureCause. Returns the `Throwable` that caused this service to fail.
public final boolean	isRunning() Implements com.google.common.util.concurrent.Service.isRunning. Returns `true` if this service is running.
protected final void	notifyFailed(Throwable cause) Invoke this method to transition the service to the `State#FAILED`.
protected final void	notifyStarted() Implementing classes should invoke this method once their service has started.
protected final void	notifyStopped() Implementing classes should invoke this method once their service has stopped.
public final Service	startAsync() Implements com.google.common.util.concurrent.Service.startAsync. If the service state is `State#NEW`, this initiates service startup and returns immediately.
public final Service.State	state() Implements com.google.common.util.concurrent.Service.state. Returns the lifecycle state of the service.
public final Service	stopAsync() Implements com.google.common.util.concurrent.Service.stopAsync. If the service is starting or running, this initiates service shutdown and returns immediately.
private static ListenerCallQueue.Event<Service.Listener>	stoppingEvent(final Service.State from)
private static ListenerCallQueue.Event<Service.Listener>	terminatedEvent(final Service.State from)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

hasReachedRunning	back to summary
private final Monitor.Guard hasReachedRunning

isStartable	back to summary
private final Monitor.Guard isStartable

isStoppable	back to summary
private final Monitor.Guard isStoppable

isStopped	back to summary
private final Monitor.Guard isStopped

listeners	back to summary
private final ListenerCallQueue<Service.Listener> listeners The listeners to notify during a state transition.

monitor	back to summary
private final Monitor monitor

RUNNING_EVENT	back to summary
private static final ListenerCallQueue.Event<Service.Listener> RUNNING_EVENT

snapshot back to summary

snapshot	back to summary
private volatile AbstractService.StateSnapshot snapshot The current state of the service. This should be written with the lock held but can be read without it because it is an immutable object in a volatile field. This is desirable so that methods like `state`, `failureCause` and notably `toString` can be run without grabbing the lock. To update this field correctly the lock must be held to guarantee that the state is consistent.

private volatile AbstractService.StateSnapshot snapshot

The current state of the service. This should be written with the lock held but can be read without it because it is an immutable object in a volatile field. This is desirable so that methods like state, failureCause and notably toString can be run without grabbing the lock.

To update this field correctly the lock must be held to guarantee that the state is consistent.

STARTING_EVENT	back to summary
private static final ListenerCallQueue.Event<Service.Listener> STARTING_EVENT

STOPPING_FROM_RUNNING_EVENT	back to summary
private static final ListenerCallQueue.Event<Service.Listener> STOPPING_FROM_RUNNING_EVENT

STOPPING_FROM_STARTING_EVENT	back to summary
private static final ListenerCallQueue.Event<Service.Listener> STOPPING_FROM_STARTING_EVENT

TERMINATED_FROM_NEW_EVENT	back to summary
private static final ListenerCallQueue.Event<Service.Listener> TERMINATED_FROM_NEW_EVENT

TERMINATED_FROM_RUNNING_EVENT	back to summary
private static final ListenerCallQueue.Event<Service.Listener> TERMINATED_FROM_RUNNING_EVENT

TERMINATED_FROM_STARTING_EVENT	back to summary
private static final ListenerCallQueue.Event<Service.Listener> TERMINATED_FROM_STARTING_EVENT

TERMINATED_FROM_STOPPING_EVENT	back to summary
private static final ListenerCallQueue.Event<Service.Listener> TERMINATED_FROM_STOPPING_EVENT

Constructor Detail

AbstractService	back to summary
protected AbstractService() Constructor for use by subclasses.

Method Detail

addListener back to summary

addListener	back to summary
public final void addListener(Service.Listener listener, Executor executor) Implements com.google.common.util.concurrent.Service.addListener. Doc from com.google.common.util.concurrent.Service.addListener. Registers a `Listener` to be executed on the given executor. The listener will have the corresponding transition method called whenever the service changes state. The listener will not have previous state changes replayed, so it is suggested that listeners are added before the service starts. `addListener` guarantees execution ordering across calls to a given listener but not across calls to multiple listeners. Specifically, a given listener will have its callbacks invoked in the same order as the underlying service enters those states. Additionally, at most one of the listener's callbacks will execute at once. However, multiple listeners' callbacks may execute concurrently, and listeners may execute in an order different from the one in which they were registered. RuntimeExceptions thrown by a listener will be caught and logged. Any exception thrown during `Executor.execute` (e.g., a `RejectedExecutionException`) will be caught and logged. Parameters listener:Service.Listener the listener to run when the service changes state is complete executor:Executor the executor in which the listeners callback methods will be run. For fast, lightweight listeners that would be safe to execute in any thread, consider `MoreExecutors#directExecutor`. Annotations @Override Since 13.0

public final void addListener(Service.Listener listener, Executor executor)

Implements com.google.common.util.concurrent.Service.addListener.

Doc from com.google.common.util.concurrent.Service.addListener.

Registers a Listener to be executed on the given executor. The listener will have the corresponding transition method called whenever the service changes state. The listener will not have previous state changes replayed, so it is suggested that listeners are added before the service starts.

addListener guarantees execution ordering across calls to a given listener but not across calls to multiple listeners. Specifically, a given listener will have its callbacks invoked in the same order as the underlying service enters those states. Additionally, at most one of the listener's callbacks will execute at once. However, multiple listeners' callbacks may execute concurrently, and listeners may execute in an order different from the one in which they were registered.

RuntimeExceptions thrown by a listener will be caught and logged. Any exception thrown during Executor.execute (e.g., a RejectedExecutionException) will be caught and logged.

Parameters

listener:Service.Listener: the listener to run when the service changes state is complete
executor:Executor: the executor in which the listeners callback methods will be run. For fast, lightweight listeners that would be safe to execute in any thread, consider MoreExecutors#directExecutor.

Annotations

@Override

Since

13.0

awaitRunning back to summary

awaitRunning	back to summary
public final void awaitRunning() Implements com.google.common.util.concurrent.Service.awaitRunning. Doc from com.google.common.util.concurrent.Service.awaitRunning. Waits for the `Service` to reach the running state. Annotations @Override

public final void awaitRunning()

Implements com.google.common.util.concurrent.Service.awaitRunning.

Doc from com.google.common.util.concurrent.Service.awaitRunning.

Waits for the Service to reach the running state.

Annotations

@Override

awaitRunning back to summary

awaitRunning	back to summary
public final void awaitRunning(Duration timeout) throws TimeoutException Overrides default com.google.common.util.concurrent.Service.awaitRunning. Doc from com.google.common.util.concurrent.Service.awaitRunning. Waits for the `Service` to reach the running state for no more than the given time. Parameters timeout:Duration the maximum time to wait Annotations @Override Exceptions TimeoutException: if the service has not reached the given state within the deadline Since 28.0

public final void awaitRunning(Duration timeout) throws TimeoutException

Overrides default com.google.common.util.concurrent.Service.awaitRunning.

Doc from com.google.common.util.concurrent.Service.awaitRunning.

Waits for the Service to reach the running state for no more than the given time.

Parameters

timeout:Duration: the maximum time to wait

Annotations

@Override

Exceptions

TimeoutException:: if the service has not reached the given state within the deadline

Since

28.0

awaitRunning back to summary

awaitRunning	back to summary
public final void awaitRunning(long timeout, TimeUnit unit) throws TimeoutException Implements com.google.common.util.concurrent.Service.awaitRunning. Doc from com.google.common.util.concurrent.Service.awaitRunning. Waits for the `Service` to reach the running state for no more than the given time. Parameters timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Annotations @Override Exceptions TimeoutException: if the service has not reached the given state within the deadline

public final void awaitRunning(long timeout, TimeUnit unit) throws TimeoutException

Implements com.google.common.util.concurrent.Service.awaitRunning.

Doc from com.google.common.util.concurrent.Service.awaitRunning.

Waits for the Service to reach the running state for no more than the given time.

Parameters

timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Annotations

@Override

Exceptions

TimeoutException:: if the service has not reached the given state within the deadline

awaitTerminated back to summary

awaitTerminated	back to summary
public final void awaitTerminated() Implements com.google.common.util.concurrent.Service.awaitTerminated. Doc from com.google.common.util.concurrent.Service.awaitTerminated. Waits for the `Service` to reach the terminated state. Annotations @Override

public final void awaitTerminated()

Implements com.google.common.util.concurrent.Service.awaitTerminated.

Doc from com.google.common.util.concurrent.Service.awaitTerminated.

Waits for the Service to reach the terminated state.

Annotations

@Override

awaitTerminated back to summary

awaitTerminated	back to summary
public final void awaitTerminated(Duration timeout) throws TimeoutException Overrides default com.google.common.util.concurrent.Service.awaitTerminated. Doc from com.google.common.util.concurrent.Service.awaitTerminated. Waits for the `Service` to reach a terminal state (either `terminated` or `failed`) for no more than the given time. Parameters timeout:Duration the maximum time to wait Annotations @Override Exceptions TimeoutException: if the service has not reached the given state within the deadline Since 28.0

public final void awaitTerminated(Duration timeout) throws TimeoutException

Overrides default com.google.common.util.concurrent.Service.awaitTerminated.

Doc from com.google.common.util.concurrent.Service.awaitTerminated.

Waits for the Service to reach a terminal state (either terminated or failed) for no more than the given time.

Parameters

timeout:Duration: the maximum time to wait

Annotations

@Override

Exceptions

TimeoutException:: if the service has not reached the given state within the deadline

Since

28.0

awaitTerminated back to summary

awaitTerminated	back to summary
public final void awaitTerminated(long timeout, TimeUnit unit) throws TimeoutException Implements com.google.common.util.concurrent.Service.awaitTerminated. Doc from com.google.common.util.concurrent.Service.awaitTerminated. Waits for the `Service` to reach a terminal state (either `terminated` or `failed`) for no more than the given time. Parameters timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Annotations @Override Exceptions TimeoutException: if the service has not reached the given state within the deadline

public final void awaitTerminated(long timeout, TimeUnit unit) throws TimeoutException

Implements com.google.common.util.concurrent.Service.awaitTerminated.

Doc from com.google.common.util.concurrent.Service.awaitTerminated.

Waits for the Service to reach a terminal state (either terminated or failed) for no more than the given time.

Parameters

timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Annotations

@Override

Exceptions

TimeoutException:: if the service has not reached the given state within the deadline

checkCurrentState	back to summary
private void checkCurrentState(Service.State expected) Checks that the current state is equal to the expected state. Annotations @GuardedBy:monitor

checkCurrentState

back to summary

private void checkCurrentState(Service.State expected)

Checks that the current state is equal to the expected state.

Annotations

@GuardedBy:monitor

dispatchListenerEvents	back to summary
private void dispatchListenerEvents() Attempts to execute all the listeners in `listeners` while not holding the `monitor`.

doCancelStart back to summary

doCancelStart	back to summary
protected void doCancelStart() This method is called by `stopAsync` when the service is still starting (i.e. `startAsync` has been called but `notifyStarted` has not). Subclasses can override the method to cancel pending work and then call `notifyStopped` to stop the service. This method should return promptly; prefer to do work on a different thread where it is convenient. It is invoked exactly once on service shutdown, even when `stopAsync` is called multiple times. When this method is called `state()` will return `State#STOPPING`, which is the external state observable by the caller of `stopAsync`. Annotations @ForOverride Since 27.0

protected void doCancelStart()

This method is called by stopAsync when the service is still starting (i.e. startAsync has been called but notifyStarted has not). Subclasses can override the method to cancel pending work and then call notifyStopped to stop the service.

This method should return promptly; prefer to do work on a different thread where it is convenient. It is invoked exactly once on service shutdown, even when stopAsync is called multiple times.

When this method is called state() will return State#STOPPING, which is the external state observable by the caller of stopAsync.

Annotations

@ForOverride

Since

27.0

doStart back to summary

doStart	back to summary
protected abstract void doStart() This method is called by `startAsync` to initiate service startup. The invocation of this method should cause a call to `notifyStarted()`, either during this method's run, or after it has returned. If startup fails, the invocation should cause a call to `notifyFailed(Throwable)` instead. This method should return promptly; prefer to do work on a different thread where it is convenient. It is invoked exactly once on service startup, even when `startAsync` is called multiple times. Annotations @ForOverride

protected abstract void doStart()

This method is called by startAsync to initiate service startup. The invocation of this method should cause a call to notifyStarted(), either during this method's run, or after it has returned. If startup fails, the invocation should cause a call to notifyFailed(Throwable) instead.

This method should return promptly; prefer to do work on a different thread where it is convenient. It is invoked exactly once on service startup, even when startAsync is called multiple times.

Annotations

@ForOverride

doStop back to summary

doStop	back to summary
protected abstract void doStop() This method should be used to initiate service shutdown. The invocation of this method should cause a call to `notifyStopped()`, either during this method's run, or after it has returned. If shutdown fails, the invocation should cause a call to `notifyFailed(Throwable)` instead. This method should return promptly; prefer to do work on a different thread where it is convenient. It is invoked exactly once on service shutdown, even when `stopAsync` is called multiple times. If `stopAsync` is called on a `State#STARTING` service, this method is not invoked immediately. Instead, it will be deferred until after the service is `State#RUNNING`. Services that need to cancel startup work can override `doCancelStart`. Annotations @ForOverride

protected abstract void doStop()

This method should be used to initiate service shutdown. The invocation of this method should cause a call to notifyStopped(), either during this method's run, or after it has returned. If shutdown fails, the invocation should cause a call to notifyFailed(Throwable) instead.

This method should return promptly; prefer to do work on a different thread where it is convenient. It is invoked exactly once on service shutdown, even when stopAsync is called multiple times.

If stopAsync is called on a State#STARTING service, this method is not invoked immediately. Instead, it will be deferred until after the service is State#RUNNING. Services that need to cancel startup work can override doCancelStart.

Annotations

@ForOverride

enqueueFailedEvent	back to summary
private void enqueueFailedEvent(final Service.State from, final Throwable cause)

enqueueRunningEvent	back to summary
private void enqueueRunningEvent()

enqueueStartingEvent	back to summary
private void enqueueStartingEvent()

enqueueStoppingEvent	back to summary
private void enqueueStoppingEvent(final Service.State from)

enqueueTerminatedEvent	back to summary
private void enqueueTerminatedEvent(final Service.State from)

failureCause back to summary

failureCause	back to summary
public final Throwable failureCause() Implements com.google.common.util.concurrent.Service.failureCause. Doc from com.google.common.util.concurrent.Service.failureCause. Returns the `Throwable` that caused this service to fail. Annotations @Override Since 14.0

public final Throwable failureCause()

Implements com.google.common.util.concurrent.Service.failureCause.

Doc from com.google.common.util.concurrent.Service.failureCause.

Returns the Throwable that caused this service to fail.

Annotations

@Override

Since

14.0

isRunning back to summary

isRunning	back to summary
public final boolean isRunning() Implements com.google.common.util.concurrent.Service.isRunning. Doc from com.google.common.util.concurrent.Service.isRunning. Returns `true` if this service is running. Annotations @Override

public final boolean isRunning()

Implements com.google.common.util.concurrent.Service.isRunning.

Doc from com.google.common.util.concurrent.Service.isRunning.

Returns true if this service is running.

Annotations

@Override

notifyFailed	back to summary
protected final void notifyFailed(Throwable cause) Invoke this method to transition the service to the `State#FAILED`. The service will not be stopped if it is running. Invoke this method when a service has failed critically or otherwise cannot be started nor stopped.

notifyStarted back to summary

notifyStarted	back to summary
protected final void notifyStarted() Implementing classes should invoke this method once their service has started. It will cause the service to transition from `State#STARTING` to `State#RUNNING`. Exceptions IllegalStateException: if the service is not `State#STARTING`.

protected final void notifyStarted()

Implementing classes should invoke this method once their service has started. It will cause the service to transition from State#STARTING to State#RUNNING.

Exceptions

IllegalStateException:: if the service is not State#STARTING.

notifyStopped back to summary

notifyStopped	back to summary
protected final void notifyStopped() Implementing classes should invoke this method once their service has stopped. It will cause the service to transition from `State#STARTING` or `State#STOPPING` to `State#TERMINATED`. Exceptions IllegalStateException: if the service is not one of `State#STOPPING`, `State#STARTING`, or `State#RUNNING`.

protected final void notifyStopped()

Implementing classes should invoke this method once their service has stopped. It will cause the service to transition from State#STARTING or State#STOPPING to State#TERMINATED.

Exceptions

IllegalStateException:: if the service is not one of State#STOPPING, State#STARTING, or State#RUNNING.

startAsync back to summary

startAsync	back to summary
public final Service startAsync() Implements com.google.common.util.concurrent.Service.startAsync. Doc from com.google.common.util.concurrent.Service.startAsync. If the service state is `State#NEW`, this initiates service startup and returns immediately. A stopped service may not be restarted. Returns:Service this Annotations @CanIgnoreReturnValue @Override

public final Service startAsync()

Implements com.google.common.util.concurrent.Service.startAsync.

Doc from com.google.common.util.concurrent.Service.startAsync.

If the service state is State#NEW, this initiates service startup and returns immediately. A stopped service may not be restarted.

Returns:Service

this

Annotations

@CanIgnoreReturnValue
@Override

state	back to summary
public final Service.State state() Implements com.google.common.util.concurrent.Service.state. Doc from com.google.common.util.concurrent.Service.state. Returns the lifecycle state of the service. Annotations @Override

state

back to summary

public final Service.State state()

Implements com.google.common.util.concurrent.Service.state.

Doc from com.google.common.util.concurrent.Service.state.

Returns the lifecycle state of the service.

Annotations

@Override

stopAsync	back to summary
public final Service stopAsync() Implements com.google.common.util.concurrent.Service.stopAsync. Doc from com.google.common.util.concurrent.Service.stopAsync. If the service is starting or running, this initiates service shutdown and returns immediately. If the service is new, it is terminated without having been started nor stopped. If the service has already been stopped, this method returns immediately without taking action. Returns:Service this Annotations @CanIgnoreReturnValue @Override

stopAsync

back to summary

public final Service stopAsync()

Implements com.google.common.util.concurrent.Service.stopAsync.

Doc from com.google.common.util.concurrent.Service.stopAsync.

If the service is starting or running, this initiates service shutdown and returns immediately. If the service is new, it is terminated without having been started nor stopped. If the service has already been stopped, this method returns immediately without taking action.

Returns:Service

this

Annotations

@CanIgnoreReturnValue
@Override

stoppingEvent	back to summary
private static ListenerCallQueue.Event<Service.Listener> stoppingEvent(final Service.State from)

terminatedEvent	back to summary
private static ListenerCallQueue.Event<Service.Listener> terminatedEvent(final Service.State from)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

com.google.common.util.concurrent back to summary

private final Class AbstractService.HasReachedRunningGuard

Class Inheritance

extends Guard

java.lang.Object
com.google.common.util.concurrent.Monitor.Guard
com.google.common.util.concurrent.AbstractService.HasReachedRunningGuard

Annotations

@WeakOuter

Field Summary

Inherited from com.google.common.util.concurrent.Monitor.Guard:: condition monitor next waiterCount

Constructor Summary

Access	Constructor and Description
pack-priv	HasReachedRunningGuard()

Method Summary

Modifier and Type	Method and Description
public boolean	isSatisfied() Implements abstract com.google.common.util.concurrent.Monitor.Guard.isSatisfied. Evaluates this guard's boolean condition.

Constructor Detail

HasReachedRunningGuard	back to summary
pack-priv HasReachedRunningGuard()

Method Detail

isSatisfied

back to summary

public boolean isSatisfied()

Implements abstract com.google.common.util.concurrent.Monitor.Guard.isSatisfied.

Doc from com.google.common.util.concurrent.Monitor.Guard.isSatisfied.

Evaluates this guard's boolean condition. This method is always called with the associated monitor already occupied. Implementations of this method must depend only on state protected by the associated monitor, and must not modify that state.

Annotations

@Override

com.google.common.util.concurrent back to summary

private final Class AbstractService.IsStartableGuard

Class Inheritance

extends Guard

java.lang.Object
com.google.common.util.concurrent.Monitor.Guard
com.google.common.util.concurrent.AbstractService.IsStartableGuard

Annotations

@WeakOuter

Field Summary

Inherited from com.google.common.util.concurrent.Monitor.Guard:: condition monitor next waiterCount

Constructor Summary

Access	Constructor and Description
pack-priv	IsStartableGuard()

Method Summary

Modifier and Type	Method and Description
public boolean	isSatisfied() Implements abstract com.google.common.util.concurrent.Monitor.Guard.isSatisfied. Evaluates this guard's boolean condition.

Constructor Detail

IsStartableGuard	back to summary
pack-priv IsStartableGuard()

Method Detail

isSatisfied

back to summary

public boolean isSatisfied()

Implements abstract com.google.common.util.concurrent.Monitor.Guard.isSatisfied.

Doc from com.google.common.util.concurrent.Monitor.Guard.isSatisfied.

Annotations

@Override

com.google.common.util.concurrent back to summary

private final Class AbstractService.IsStoppableGuard

Class Inheritance

extends Guard

java.lang.Object
com.google.common.util.concurrent.Monitor.Guard
com.google.common.util.concurrent.AbstractService.IsStoppableGuard

Annotations

@WeakOuter

Field Summary

Inherited from com.google.common.util.concurrent.Monitor.Guard:: condition monitor next waiterCount

Constructor Summary

Access	Constructor and Description
pack-priv	IsStoppableGuard()

Method Summary

Modifier and Type	Method and Description
public boolean	isSatisfied() Implements abstract com.google.common.util.concurrent.Monitor.Guard.isSatisfied. Evaluates this guard's boolean condition.

Constructor Detail

IsStoppableGuard	back to summary
pack-priv IsStoppableGuard()

Method Detail

isSatisfied

back to summary

public boolean isSatisfied()

Implements abstract com.google.common.util.concurrent.Monitor.Guard.isSatisfied.

Doc from com.google.common.util.concurrent.Monitor.Guard.isSatisfied.

Annotations

@Override

com.google.common.util.concurrent back to summary

private final Class AbstractService.IsStoppedGuard

Class Inheritance

extends Guard

java.lang.Object
com.google.common.util.concurrent.Monitor.Guard
com.google.common.util.concurrent.AbstractService.IsStoppedGuard

Annotations

@WeakOuter

Field Summary

Inherited from com.google.common.util.concurrent.Monitor.Guard:: condition monitor next waiterCount

Constructor Summary

Access	Constructor and Description
pack-priv	IsStoppedGuard()

Method Summary

Modifier and Type	Method and Description
public boolean	isSatisfied() Implements abstract com.google.common.util.concurrent.Monitor.Guard.isSatisfied. Evaluates this guard's boolean condition.

Constructor Detail

IsStoppedGuard	back to summary
pack-priv IsStoppedGuard()

Method Detail

isSatisfied

back to summary

public boolean isSatisfied()

Implements abstract com.google.common.util.concurrent.Monitor.Guard.isSatisfied.

Doc from com.google.common.util.concurrent.Monitor.Guard.isSatisfied.

Annotations

@Override

com.google.common.util.concurrent back to summary

private final Class AbstractService.StateSnapshot

Class Inheritance

extends Object

java.lang.Object
com.google.common.util.concurrent.AbstractService.StateSnapshot

An immutable snapshot of the current state of the service. This class represents a consistent snapshot of the state and therefore it can be used to answer simple queries without needing to grab a lock.

Field Summary

Modifier and Type	Field and Description
pack-priv final Throwable	failure The exception that caused this service to fail.
pack-priv final boolean	shutdownWhenStartupFinishes If true, the user requested a shutdown while the service was still starting up.
pack-priv final Service.State	state The internal state, which equals external state unless shutdownWhenStartupFinishes is true.

Constructor Summary

Access	Constructor and Description
pack-priv	StateSnapshot(Service.State internalState)
pack-priv	StateSnapshot(Service.State internalState, boolean shutdownWhenStartupFinishes, Throwable failure)

Method Summary

Modifier and Type	Method and Description
pack-priv Service.State	externalState()
pack-priv Throwable	failureCause()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

failure	back to summary
pack-priv final Throwable failure The exception that caused this service to fail. This will be `null` unless the service has failed. Annotations @CheckForNull

shutdownWhenStartupFinishes	back to summary
pack-priv final boolean shutdownWhenStartupFinishes If true, the user requested a shutdown while the service was still starting up.

state	back to summary
pack-priv final Service.State state The internal state, which equals external state unless shutdownWhenStartupFinishes is true.

Constructor Detail

StateSnapshot	back to summary
pack-priv StateSnapshot(Service.State internalState)

StateSnapshot	back to summary
pack-priv StateSnapshot(Service.State internalState, boolean shutdownWhenStartupFinishes, Throwable failure)

Method Detail

externalState	back to summary
pack-priv Service.State externalState() See Also `Service#state()`

failureCause	back to summary
pack-priv Throwable failureCause() See Also `Service#failureCause()`

public abstract Class AbstractService

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class AbstractService.HasReachedRunningGuard

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class AbstractService.IsStartableGuard

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class AbstractService.IsStoppableGuard

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class AbstractService.IsStoppedGuard

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class AbstractService.StateSnapshot

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail