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  package org.apache.commons.nabla.automatic.analysis;
18  
19  import org.apache.commons.nabla.core.DifferentiationException;
20  
21  /** Class used for delayed error reporting.
22   */
23  public class ErrorReporter {
24  
25      /** Error report. */
26      private DifferentiationException reportedError;
27  
28      /** Register an exception to be reported later.
29       * @param exception exception to be reported
30       */
31      public void register(final DifferentiationException exception) {
32          reportedError = exception;
33      }
34  
35      /** Check if an error has already been registered.
36       * @return true if an error has already been registered
37       */
38      public boolean hasError() {
39          return reportedError != null;
40      }
41  
42      /** Report the error if any.
43       * <p>If not error has been reported (i.e. if {@link #hasError()} returns
44       * <code>false</code>), this method does nothing. Otherwise, it rethrows
45       * the original exception.</p>
46       * @exception DifferentiationException if some error occurred
47       * during differentiation
48       */
49      public void reportErrors() throws DifferentiationException {
50          if (reportedError != null) {
51              throw reportedError;
52          }
53      }
54  
55  }