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.ExceptionContext;
21  import org.apache.commons.math3.exception.util.ExceptionContextProvider;
22  
23  /**
24   * Base class for all preconditions violation exceptions.
25   * In most cases, this class should not be instantiated directly: it should
26   * serve as a base class to create all the exceptions that have the semantics
27   * of the standard {@link IllegalArgumentException}.
28   *
29   * @since 2.2
30   * @version $Id: MathIllegalArgumentException.java 1364378 2012-07-22 17:42:38Z tn $
31   */
32  public class MathIllegalArgumentException extends IllegalArgumentException
33      implements ExceptionContextProvider {
34      /** Serializable version Id. */
35      private static final long serialVersionUID = -6024911025449780478L;
36      /** Context. */
37      private final ExceptionContext context;
38  
39      /**
40       * @param pattern Message pattern explaining the cause of the error.
41       * @param args Arguments.
42       */
43      public MathIllegalArgumentException(Localizable pattern,
44                                          Object ... args) {
45          context = new ExceptionContext(this);
46          context.addMessage(pattern, args);
47      }
48  
49      /** {@inheritDoc} */
50      public ExceptionContext getContext() {
51          return context;
52      }
53  
54      /** {@inheritDoc} */
55      @Override
56      public String getMessage() {
57          return context.getMessage();
58      }
59  
60      /** {@inheritDoc} */
61      @Override
62      public String getLocalizedMessage() {
63          return context.getLocalizedMessage();
64      }
65  }