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   */
32  public class MathArithmeticException extends ArithmeticException
33      implements ExceptionContextProvider {
34      /** Serializable version Id. */
35      private static final long serialVersionUID = -6024911025449780478L;
36      /** Context. */
37      private final ExceptionContext context;
38  
39      /**
40       * Default constructor.
41       */
42      public MathArithmeticException() {
43          context = new ExceptionContext(this);
44          context.addMessage(LocalizedFormats.ARITHMETIC_EXCEPTION);
45      }
46  
47      /**
48       * Constructor with a specific message.
49       *
50       * @param pattern Message pattern providing the specific context of
51       * the error.
52       * @param args Arguments.
53       */
54      public MathArithmeticException(Localizable pattern,
55                                     Object ... args) {
56          context = new ExceptionContext(this);
57          context.addMessage(pattern, args);
58      }
59  
60      /** {@inheritDoc} */
61      public ExceptionContext getContext() {
62          return context;
63      }
64  
65      /** {@inheritDoc} */
66      @Override
67      public String getMessage() {
68          return context.getMessage();
69      }
70  
71      /** {@inheritDoc} */
72      @Override
73      public String getLocalizedMessage() {
74          return context.getLocalizedMessage();
75      }
76  }