MathArithmeticException.java

  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. import org.apache.commons.math3.exception.util.Localizable;
  19. import org.apache.commons.math3.exception.util.LocalizedFormats;
  20. import org.apache.commons.math3.exception.util.ExceptionContext;
  21. import org.apache.commons.math3.exception.util.ExceptionContextProvider;

  22. /**
  23.  * Base class for arithmetic exceptions.
  24.  * It is used for all the exceptions that have the semantics of the standard
  25.  * {@link ArithmeticException}, but must also provide a localized
  26.  * message.
  27.  *
  28.  * @since 3.0
  29.  */
  30. public class MathArithmeticException extends ArithmeticException
  31.     implements ExceptionContextProvider {
  32.     /** Serializable version Id. */
  33.     private static final long serialVersionUID = -6024911025449780478L;
  34.     /** Context. */
  35.     private final ExceptionContext context;

  36.     /**
  37.      * Default constructor.
  38.      */
  39.     public MathArithmeticException() {
  40.         context = new ExceptionContext(this);
  41.         context.addMessage(LocalizedFormats.ARITHMETIC_EXCEPTION);
  42.     }

  43.     /**
  44.      * Constructor with a specific message.
  45.      *
  46.      * @param pattern Message pattern providing the specific context of
  47.      * the error.
  48.      * @param args Arguments.
  49.      */
  50.     public MathArithmeticException(Localizable pattern,
  51.                                    Object ... args) {
  52.         context = new ExceptionContext(this);
  53.         context.addMessage(pattern, args);
  54.     }

  55.     /** {@inheritDoc} */
  56.     public ExceptionContext getContext() {
  57.         return context;
  58.     }

  59.     /** {@inheritDoc} */
  60.     @Override
  61.     public String getMessage() {
  62.         return context.getMessage();
  63.     }

  64.     /** {@inheritDoc} */
  65.     @Override
  66.     public String getLocalizedMessage() {
  67.         return context.getLocalizedMessage();
  68.     }
  69. }