/*
    * Copyright 2012 The Netty Project
    *
    * The Netty Project licenses this file to you 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 org.jboss.netty.channel;
  
  import org.jboss.netty.logging.InternalLogger;
  import org.jboss.netty.logging.InternalLoggerFactory;
  
  import java.util.concurrent.TimeUnit;
  
  /**
   * A skeletal {@link ChannelFuture} implementation which represents a
   * {@link ChannelFuture} which has been completed already.
   */
  public abstract class CompleteChannelFuture implements ChannelFuture {
  
      private static final InternalLogger logger =
          InternalLoggerFactory.getInstance(CompleteChannelFuture.class);
  
      private final Channel channel;
  
      /**
       * Creates a new instance.
       *
       * @param channel the {@link Channel} associated with this future
       */
      protected CompleteChannelFuture(Channel channel) {
          if (channel == null) {
              throw new NullPointerException("channel");
          }
          this.channel = channel;
      }
  
      public void addListener(ChannelFutureListener listener) {
          try {
              listener.operationComplete(this);
          } catch (Throwable t) {
              if (logger.isWarnEnabled()) {
                  logger.warn(
                          "An exception was thrown by " +
                          ChannelFutureListener.class.getSimpleName() + '.', t);
              }
          }
      }
  
      public void removeListener(ChannelFutureListener listener) {
          // NOOP
      }
  
      public ChannelFuture await() throws InterruptedException {
          if (Thread.interrupted()) {
              throw new InterruptedException();
          }
          return this;
      }
  
      public boolean await(long timeout, TimeUnit unit) throws InterruptedException {
          if (Thread.interrupted()) {
              throw new InterruptedException();
          }
          return true;
      }
  
      public boolean await(long timeoutMillis) throws InterruptedException {
          if (Thread.interrupted()) {
              throw new InterruptedException();
          }
          return true;
      }
  
      public ChannelFuture awaitUninterruptibly() {
          return this;
      }
  
      public boolean awaitUninterruptibly(long timeout, TimeUnit unit) {
          return true;
      }
  
      public boolean awaitUninterruptibly(long timeoutMillis) {
          return true;
      }
  
      public Channel getChannel() {
          return channel;
      }
  
      public boolean isDone() {
         return true;
     }
 
     public boolean setProgress(long amount, long current, long total) {
         return false;
     }
 
     public boolean setFailure(Throwable cause) {
         return false;
     }
 
     public boolean setSuccess() {
         return false;
     }
 
     public boolean cancel() {
         return false;
     }
 
     public boolean isCancelled() {
         return false;
     }
 }