View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.net.io;
19  
20  import java.io.IOException;
21  
22  /**
23   * The CopyStreamException class is thrown by the org.apache.commons.io.Util
24   * copyStream() methods.  It stores the number of bytes confirmed to
25   * have been transferred before an I/O error as well as the IOException
26   * responsible for the failure of a copy operation.
27   * @see Util
28   * @version $Id: CopyStreamException.java 1299238 2012-03-10 17:12:28Z sebb $
29   */
30  public class CopyStreamException extends IOException
31  {
32      private static final long serialVersionUID = -2602899129433221532L;
33  
34      private final long totalBytesTransferred;
35  
36      /**
37       * Creates a new CopyStreamException instance.
38       * @param message  A message describing the error.
39       * @param bytesTransferred  The total number of bytes transferred before
40       *        an exception was thrown in a copy operation.
41       * @param exception  The IOException thrown during a copy operation.
42       */
43      public CopyStreamException(String message,
44                                 long bytesTransferred,
45                                 IOException exception)
46      {
47          super(message);
48          initCause(exception); // merge this into super() call once we need 1.6+
49          totalBytesTransferred = bytesTransferred;
50      }
51  
52      /**
53       * Returns the total number of bytes confirmed to have
54       * been transferred by a failed copy operation.
55       * @return The total number of bytes confirmed to have
56       * been transferred by a failed copy operation.
57       */
58      public long getTotalBytesTransferred()
59      {
60          return totalBytesTransferred;
61      }
62  
63      /**
64       * Returns the IOException responsible for the failure of a copy operation.
65       * @return The IOException responsible for the failure of a copy operation.
66       */
67      public IOException getIOException()
68      {
69          return (IOException) getCause(); // cast is OK because it was initialised with an IOException
70      }
71  }