org.apache.commons.net.io
Class CopyStreamException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.io.IOException
              extended by org.apache.commons.net.io.CopyStreamException
All Implemented Interfaces:
Serializable

public class CopyStreamException
extends IOException

The CopyStreamException class is thrown by the org.apache.commons.io.Util copyStream() methods. It stores the number of bytes confirmed to have been transferred before an I/O error as well as the IOException responsible for the failure of a copy operation.

Version:
$Id: CopyStreamException.java 1299238 2012-03-10 17:12:28Z sebb $
See Also:
Util, Serialized Form

Constructor Summary
CopyStreamException(String message, long bytesTransferred, IOException exception)
          Creates a new CopyStreamException instance.
 
Method Summary
 IOException getIOException()
          Returns the IOException responsible for the failure of a copy operation.
 long getTotalBytesTransferred()
          Returns the total number of bytes confirmed to have been transferred by a failed copy operation.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CopyStreamException

public CopyStreamException(String message,
                           long bytesTransferred,
                           IOException exception)
Creates a new CopyStreamException instance.

Parameters:
message - A message describing the error.
bytesTransferred - The total number of bytes transferred before an exception was thrown in a copy operation.
exception - The IOException thrown during a copy operation.
Method Detail

getTotalBytesTransferred

public long getTotalBytesTransferred()
Returns the total number of bytes confirmed to have been transferred by a failed copy operation.

Returns:
The total number of bytes confirmed to have been transferred by a failed copy operation.

getIOException

public IOException getIOException()
Returns the IOException responsible for the failure of a copy operation.

Returns:
The IOException responsible for the failure of a copy operation.


Copyright © 2001-2012 The Apache Software Foundation. All Rights Reserved.