Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ProcessingException |
|
| 1.0;1 |
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.pipeline; | |
19 | ||
20 | import org.apache.commons.pipeline.StageDriver.State; | |
21 | ||
22 | /** | |
23 | * This exception class is used to store detailed information about | |
24 | * a failure in the processing step of a stage including the failing data, | |
25 | * the driver state at the time of failure, and any exceptions encountered. | |
26 | */ | |
27 | public class ProcessingException extends StageException { | |
28 | private final Object data; | |
29 | private final State driverState; | |
30 | ||
31 | /** | |
32 | * Creates a new instance of ProcessingException | |
33 | * | |
34 | * @param data The object which was not able to be processed. | |
35 | * @param throwable The exception that occurred. | |
36 | */ | |
37 | public ProcessingException(Stage stage, Throwable cause, Object data, State driverState) { | |
38 | 2 | super(stage, cause); |
39 | 2 | this.data = data; |
40 | 2 | this.driverState = driverState; |
41 | 2 | } |
42 | ||
43 | /** | |
44 | * Returns the object that was being processed at the time of failure. | |
45 | * @return The object which was not able to be processed. | |
46 | */ | |
47 | public Object getData(){ | |
48 | 0 | return this.data; |
49 | } | |
50 | ||
51 | /** | |
52 | * Returns the saved driver state at the time of processing failure. | |
53 | * @return the driver state at the time of processing failure. | |
54 | */ | |
55 | public State getDriverState() { | |
56 | 0 | return this.driverState; |
57 | } | |
58 | } |