Reformat to comply with new Checkstyle rules.

Matthew Swift

25.33.2012 263d085885df024dca9250cc03c807912b0a7662

 opendj3/opendj-ldap-sdk/src/main/java/com/forgerock/opendj/util/FutureResultTransformer.java

@@ -6,17 +6,16 @@
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * trunk/opendj3/legal-notices/CDDLv1_0.txt
 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
 * or http://forgerock.org/license/CDDLv1.0.html.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at
 * trunk/opendj3/legal-notices/CDDLv1_0.txt.  If applicable,
 * add the following below this CDDL HEADER, with the fields enclosed
 * by brackets "[]" replaced with your own identifying information:
 * file and include the License file at legal-notices/CDDLv1_0.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
@@ -27,8 +26,6 @@

package com.forgerock.opendj.util;



import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

@@ -36,208 +33,156 @@
import org.forgerock.opendj.ldap.FutureResult;
import org.forgerock.opendj.ldap.ResultHandler;



/**
 * An implementation of the {@code FutureResult} interface which transforms the
 * result of an asynchronous operation from one type to another. The
 * implementation ensures that the transformed is computed only once.
 *
 * @param <M>
 *          The type of the inner result.
 *            The type of the inner result.
 * @param <N>
 *          The type of the outer result.
 *            The type of the outer result.
 */
public abstract class FutureResultTransformer<M, N> implements FutureResult<N>,
    ResultHandler<M>
{
public abstract class FutureResultTransformer<M, N> implements FutureResult<N>, ResultHandler<M> {

  private final ResultHandler<? super N> handler;
    private final ResultHandler<? super N> handler;

  private volatile FutureResult<? extends M> future = null;
    private volatile FutureResult<? extends M> future = null;

  // These do not need to be volatile since the future acts as a memory
  // barrier.
  private N transformedResult = null;
    // These do not need to be volatile since the future acts as a memory
    // barrier.
    private N transformedResult = null;

  private ErrorResultException transformedErrorResult = null;
    private ErrorResultException transformedErrorResult = null;



  /**
   * Creates a new result transformer which will transform the results of an
   * inner asynchronous request.
   *
   * @param handler
   *          The outer result handler.
   */
  protected FutureResultTransformer(final ResultHandler<? super N> handler)
  {
    this.handler = handler;
  }



  /**
   * {@inheritDoc}
   */
  public final boolean cancel(final boolean mayInterruptIfRunning)
  {
    return future.cancel(mayInterruptIfRunning);
  }



  /**
   * {@inheritDoc}
   */
  public final N get() throws ErrorResultException, InterruptedException
  {
    future.get();

    // The handlers are guaranteed to have been invoked at this point.
    return get0();
  }



  /**
   * {@inheritDoc}
   */
  public final N get(final long timeout, final TimeUnit unit)
      throws ErrorResultException, TimeoutException, InterruptedException
  {
    future.get(timeout, unit);

    // The handlers are guaranteed to have been invoked at this point.
    return get0();
  }



  /**
   * {@inheritDoc}
   */
  public final int getRequestID()
  {
    return future.getRequestID();
  }



  /**
   * {@inheritDoc}
   */
  public final void handleErrorResult(final ErrorResultException error)
  {
    transformedErrorResult = transformErrorResult(error);
    if (handler != null)
    {
      handler.handleErrorResult(transformedErrorResult);
    /**
     * Creates a new result transformer which will transform the results of an
     * inner asynchronous request.
     *
     * @param handler
     *            The outer result handler.
     */
    protected FutureResultTransformer(final ResultHandler<? super N> handler) {
        this.handler = handler;
    }
  }



  /**
   * {@inheritDoc}
   */
  public final void handleResult(final M result)
  {
    try
    {
      transformedResult = transformResult(result);
      if (handler != null)
      {
        handler.handleResult(transformedResult);
      }
    /**
     * {@inheritDoc}
     */
    public final boolean cancel(final boolean mayInterruptIfRunning) {
        return future.cancel(mayInterruptIfRunning);
    }
    catch (final ErrorResultException e)
    {
      transformedErrorResult = e;
      if (handler != null)
      {
        handler.handleErrorResult(transformedErrorResult);
      }

    /**
     * {@inheritDoc}
     */
    public final N get() throws ErrorResultException, InterruptedException {
        future.get();

        // The handlers are guaranteed to have been invoked at this point.
        return get0();
    }
  }

    /**
     * {@inheritDoc}
     */
    public final N get(final long timeout, final TimeUnit unit) throws ErrorResultException,
            TimeoutException, InterruptedException {
        future.get(timeout, unit);


  /**
   * {@inheritDoc}
   */
  public final boolean isCancelled()
  {
    return future.isCancelled();
  }



  /**
   * {@inheritDoc}
   */
  public final boolean isDone()
  {
    return future.isDone();
  }



  /**
   * Sets the inner future for this result transformer. This must be done before
   * this future is published.
   *
   * @param future
   *          The inner future.
   */
  public final void setFutureResult(final FutureResult<? extends M> future)
  {
    this.future = future;
  }



  /**
   * Transforms the inner error result to an outer error result. The default
   * implementation is to return the inner error result.
   *
   * @param errorResult
   *          The inner error result.
   * @return The outer error result.
   */
  protected ErrorResultException transformErrorResult(
      final ErrorResultException errorResult)
  {
    return errorResult;
  }



  /**
   * Transforms the inner result to an outer result, possibly throwing an
   * {@code ErrorResultException} if the transformation fails for some reason.
   *
   * @param result
   *          The inner result.
   * @return The outer result.
   * @throws ErrorResultException
   *           If the transformation fails for some reason.
   */
  protected abstract N transformResult(M result) throws ErrorResultException;



  private N get0() throws ErrorResultException
  {
    if (transformedErrorResult != null)
    {
      throw transformedErrorResult;
        // The handlers are guaranteed to have been invoked at this point.
        return get0();
    }
    else
    {
      return transformedResult;

    /**
     * {@inheritDoc}
     */
    public final int getRequestID() {
        return future.getRequestID();
    }
  }

    /**
     * {@inheritDoc}
     */
    public final void handleErrorResult(final ErrorResultException error) {
        transformedErrorResult = transformErrorResult(error);
        if (handler != null) {
            handler.handleErrorResult(transformedErrorResult);
        }
    }

    /**
     * {@inheritDoc}
     */
    public final void handleResult(final M result) {
        try {
            transformedResult = transformResult(result);
            if (handler != null) {
                handler.handleResult(transformedResult);
            }
        } catch (final ErrorResultException e) {
            transformedErrorResult = e;
            if (handler != null) {
                handler.handleErrorResult(transformedErrorResult);
            }
        }
    }

    /**
     * {@inheritDoc}
     */
    public final boolean isCancelled() {
        return future.isCancelled();
    }

    /**
     * {@inheritDoc}
     */
    public final boolean isDone() {
        return future.isDone();
    }

    /**
     * Sets the inner future for this result transformer. This must be done
     * before this future is published.
     *
     * @param future
     *            The inner future.
     */
    public final void setFutureResult(final FutureResult<? extends M> future) {
        this.future = future;
    }

    /**
     * Transforms the inner error result to an outer error result. The default
     * implementation is to return the inner error result.
     *
     * @param errorResult
     *            The inner error result.
     * @return The outer error result.
     */
    protected ErrorResultException transformErrorResult(final ErrorResultException errorResult) {
        return errorResult;
    }

    /**
     * Transforms the inner result to an outer result, possibly throwing an
     * {@code ErrorResultException} if the transformation fails for some reason.
     *
     * @param result
     *            The inner result.
     * @return The outer result.
     * @throws ErrorResultException
     *             If the transformation fails for some reason.
     */
    protected abstract N transformResult(M result) throws ErrorResultException;

    private N get0() throws ErrorResultException {
        if (transformedErrorResult != null) {
            throw transformedErrorResult;
        } else {
            return transformedResult;
        }
    }

}