com.google.common.util.concurrent.ForwardingService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of guava Show documentation

Guava is a suite of core and expanded libraries that include utility classes, google's collections, io classes, and much much more. Guava has two code dependencies - javax.annotation per the JSR-305 spec and javax.inject per the JSR-330 spec. This is a fork of Guava 14.0.1 for Hudson.

The newest version!

/*
 * Copyright (C) 2009 The Guava Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.common.util.concurrent;

import com.google.common.annotations.Beta;
import com.google.common.collect.ForwardingObject;

import java.util.concurrent.Executor;

/**
 * A {@link Service} that forwards all method calls to another service.
 *
 * @deprecated Instead of using a {@link ForwardingService}, consider using the 
 * {@link Service.Listener} functionality to hook into the {@link Service} 
 * lifecycle, or if you really do need to provide access to some Service 
 * methods, consider just providing the few that you actually need (e.g. just 
 * {@link #startAndWait()}) and not implementing Service.
 *
 * @author Chris Nokleberg
 * @since 1.0
 */
@Beta
@Deprecated
public abstract class ForwardingService extends ForwardingObject
    implements Service {

  /** Constructor for use by subclasses. */
  protected ForwardingService() {}

  @Override protected abstract Service delegate();

  @Override public ListenableFuture start() {
    return delegate().start();
  }

  @Override public State state() {
    return delegate().state();
  }

  @Override public ListenableFuture stop() {
    return delegate().stop();
  }

  @Override public State startAndWait() {
    return delegate().startAndWait();
  }

  @Override public State stopAndWait() {
    return delegate().stopAndWait();
  }

  @Override public boolean isRunning() {
    return delegate().isRunning();
  }
  
  /**
   * @since 13.0
   */
  @Override public void addListener(Listener listener, Executor executor) {
    delegate().addListener(listener, executor);
  }

  /**
   * @since 14.0
   */
  @Override public Throwable failureCause() {
    return delegate().failureCause();
  }

  /**
   * A sensible default implementation of {@link #startAndWait()}, in terms of
   * {@link #start}. If you override {@link #start}, you may wish to override
   * {@link #startAndWait()} to forward to this implementation.
   * @since 9.0
   */
  protected State standardStartAndWait() {
    return Futures.getUnchecked(start());
  }

  /**
   * A sensible default implementation of {@link #stopAndWait()}, in terms of
   * {@link #stop}. If you override {@link #stop}, you may wish to override
   * {@link #stopAndWait()} to forward to this implementation.
   * @since 9.0
   */
  protected State standardStopAndWait() {
    return Futures.getUnchecked(stop());
  }
}