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.math3.exception;
18  
19  import org.apache.commons.math3.exception.util.Localizable;
20  import org.apache.commons.math3.exception.util.LocalizedFormats;
21  import org.apache.commons.math3.exception.util.ExceptionContext;
22  import org.apache.commons.math3.exception.util.ExceptionContextProvider;
23  
24  /**
25   * Base class for arithmetic exceptions.
26   * It is used for all the exceptions that have the semantics of the standard
27   * {@link ArithmeticException}, but must also provide a localized
28   * message.
29   *
30   * @since 3.0
31   * @version $Id: MathArithmeticException.java 1364378 2012-07-22 17:42:38Z tn $
32   */
33  public class MathArithmeticException extends ArithmeticException
34      implements ExceptionContextProvider {
35      /** Serializable version Id. */
36      private static final long serialVersionUID = -6024911025449780478L;
37      /** Context. */
38      private final ExceptionContext context;
39  
40      /**
41       * Default constructor.
42       */
43      public MathArithmeticException() {
44          context = new ExceptionContext(this);
45          context.addMessage(LocalizedFormats.ARITHMETIC_EXCEPTION);
46      }
47  
48      /**
49       * Constructor with a specific message.
50       *
51       * @param pattern Message pattern providing the specific context of
52       * the error.
53       * @param args Arguments.
54       */
55      public MathArithmeticException(Localizable pattern,
56                                     Object ... args) {
57          context = new ExceptionContext(this);
58          context.addMessage(pattern, args);
59      }
60  
61      /** {@inheritDoc} */
62      public ExceptionContext getContext() {
63          return context;
64      }
65  
66      /** {@inheritDoc} */
67      @Override
68      public String getMessage() {
69          return context.getMessage();
70      }
71  
72      /** {@inheritDoc} */
73      @Override
74      public String getLocalizedMessage() {
75          return context.getLocalizedMessage();
76      }
77  }