    View Javadoc
    1   package org.apache.commons.net.io;
    2
    3   /* ====================================================================
    4    * The Apache Software License, Version 1.1
    5    *
    6    * Copyright (c) 2001 The Apache Software Foundation.  All rights
    7    * reserved.
    8    *
    9    * Redistribution and use in source and binary forms, with or without
    10   * modification, are permitted provided that the following conditions
    11   * are met:
    12   *
    13   * 1. Redistributions of source code must retain the above copyright
    14   *    notice, this list of conditions and the following disclaimer.
    15   *
    16   * 2. Redistributions in binary form must reproduce the above copyright
    17   *    notice, this list of conditions and the following disclaimer in
    18   *    the documentation and/or other materials provided with the
    19   *    distribution.
    20   *
    21   * 3. The end-user documentation included with the redistribution,
    22   *    if any, must include the following acknowledgment:
    23   *       "This product includes software developed by the
    24   *        Apache Software Foundation (http://www.apache.org/)."
    25   *    Alternately, this acknowledgment may appear in the software itself,
    26   *    if and wherever such third-party acknowledgments normally appear.
    27   *
    28   * 4. The names "Apache" and "Apache Software Foundation" and
    29   *    "Apache Commons" must not be used to endorse or promote products
    30   *    derived from this software without prior written permission. For
    31   *    written permission, please contact apache@apache.org.
    32   *
    33   * 5. Products derived from this software may not be called "Apache",
    34   *    nor may "Apache" appear in their name, without
    35   *    prior written permission of the Apache Software Foundation.
    36   *
    37   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    38   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    39   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    40   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    41   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    42   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    43   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    44   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    45   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    46   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    47   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    48   * SUCH DAMAGE.
    49   * ====================================================================
    50   *
    51   * This software consists of voluntary contributions made by many
    52   * individuals on behalf of the Apache Software Foundation.  For more
    53   * information on the Apache Software Foundation, please see
    54   * <http://www.apache.org/>;.
    55   */
    56
    57  import java.io.IOException;
    58
    59  /***
    60   * The CopyStreamException class is thrown by the org.apache.commons.io.Util
    61   * copyStream() methods.  It stores the number of bytes confirmed to
    62   * have been transferred before an I/O error as well as the IOException
    63   * responsible for the failure of a copy operation.
    64   * @see Util
    65   * @author <a href="mailto:savarese@apache.org">Daniel F. Savarese</a>
    66   * @version $Id: CopyStreamException.java,v 1.6 2003/01/26 04:33:32 brekke Exp $
    67   */
    68  public class CopyStreamException extends IOException
    69  {
    70      private long totalBytesTransferred;
    71      private IOException ioException;
    72
    73      /***
    74       * Creates a new CopyStreamException instance.
    75       * @param message  A message describing the error.
    76       * @param bytesTransferred  The total number of bytes transferred before
    77       *        an exception was thrown in a copy operation.
    78       * @param exception  The IOException thrown during a copy operation.
    79       */
    80      public CopyStreamException(String message,
    81                                 long bytesTransferred,
    82                                 IOException exception)
    83      {
    84          super(message);
    85          totalBytesTransferred = bytesTransferred;
    86          ioException = exception;
    87      }
    88
    89      /***
    90       * Returns the total number of bytes confirmed to have
    91       * been transferred by a failed copy operation.
    92       * @return The total number of bytes confirmed to have
    93       * been transferred by a failed copy operation.
    94       */
    95      public long getTotalBytesTransferred()
    96      {
    97          return totalBytesTransferred;
    98      }
    99
    100     /***
    101      * Returns the IOException responsible for the failure of a copy operation.
    102      * @return The IOException responsible for the failure of a copy operation.
    103      */
    104     public IOException getIOException()
    105     {
    106         return ioException;
    107     }
    108 }

This page was automatically generated by Maven