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 all exceptions that signal a mismatch between the
26   * current state and the user's expectations.
27   *
28   * @since 2.2
29   * @version $Id: MathIllegalStateException.java 1364378 2012-07-22 17:42:38Z tn $
30   */
31  public class MathIllegalStateException extends IllegalStateException
32      implements ExceptionContextProvider {
33      /** Serializable version Id. */
34      private static final long serialVersionUID = -6024911025449780478L;
35      /** Context. */
36      private final ExceptionContext context;
37  
38      /**
39       * Simple constructor.
40       *
41       * @param pattern Message pattern explaining the cause of the error.
42       * @param args Arguments.
43       */
44      public MathIllegalStateException(Localizable pattern,
45                                       Object ... args) {
46          context = new ExceptionContext(this);
47          context.addMessage(pattern, args);
48      }
49  
50      /**
51       * Simple constructor.
52       *
53       * @param cause Root cause.
54       * @param pattern Message pattern explaining the cause of the error.
55       * @param args Arguments.
56       */
57      public MathIllegalStateException(Throwable cause,
58                                       Localizable pattern,
59                                       Object ... args) {
60          super(cause);
61          context = new ExceptionContext(this);
62          context.addMessage(pattern, args);
63      }
64  
65      /**
66       * Default constructor.
67       */
68      public MathIllegalStateException() {
69          this(LocalizedFormats.ILLEGAL_STATE);
70      }
71  
72      /** {@inheritDoc} */
73      public ExceptionContext getContext() {
74          return context;
75      }
76  
77      /** {@inheritDoc} */
78      @Override
79      public String getMessage() {
80          return context.getMessage();
81      }
82  
83      /** {@inheritDoc} */
84      @Override
85      public String getLocalizedMessage() {
86          return context.getLocalizedMessage();
87      }
88  }