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 * https://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 copyStream() methods. It stores the number of bytes confirmed to have been
24 * transferred before an I/O error as well as the IOException responsible for the failure of a copy operation.
25 *
26 * @see Util
27 */
28 public class CopyStreamException extends IOException {
29 private static final long serialVersionUID = -2602899129433221532L;
30
31 /**
32 * The total number of bytes confirmed to have been transferred by a failed copy operation.
33 */
34 private final long totalBytesTransferred;
35
36 /**
37 * Creates a new CopyStreamException instance.
38 *
39 * @param message A message describing the error.
40 * @param bytesTransferred The total number of bytes transferred before an exception was thrown in a copy operation.
41 * @param exception The IOException thrown during a copy operation.
42 */
43 public CopyStreamException(final String message, final long bytesTransferred, final IOException exception) {
44 super(message, exception);
45 totalBytesTransferred = bytesTransferred;
46 }
47
48 /**
49 * Gets the IOException responsible for the failure of a copy operation.
50 *
51 * @return The IOException responsible for the failure of a copy operation.
52 */
53 public IOException getIOException() {
54 return (IOException) getCause(); // cast is OK because it was initialized with an IOException
55 }
56
57 /**
58 * Gets the total number of bytes confirmed to have been transferred by a failed copy operation.
59 *
60 * @return The total number of bytes confirmed to have been transferred by a failed copy operation.
61 */
62 public long getTotalBytesTransferred() {
63 return totalBytesTransferred;
64 }
65 }