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.LocalizedFormats;
20  import org.apache.commons.math3.exception.util.Localizable;
21  
22  /**
23   * Exception to be thrown when two dimensions differ.
24   *
25   * @since 2.2
26   * @version $Id: DimensionMismatchException.java 1504729 2013-07-18 23:54:52Z sebb $
27   */
28  public class DimensionMismatchException extends MathIllegalNumberException {
29      /** Serializable version Id. */
30      private static final long serialVersionUID = -8415396756375798143L;
31      /** Correct dimension. */
32      private final int dimension;
33  
34      /**
35       * Construct an exception from the mismatched dimensions.
36       *
37       * @param specific Specific context information pattern.
38       * @param wrong Wrong dimension.
39       * @param expected Expected dimension.
40       */
41      public DimensionMismatchException(Localizable specific,
42                                        int wrong,
43                                        int expected) {
44          super(specific, Integer.valueOf(wrong), Integer.valueOf(expected));
45          dimension = expected;
46      }
47  
48      /**
49       * Construct an exception from the mismatched dimensions.
50       *
51       * @param wrong Wrong dimension.
52       * @param expected Expected dimension.
53       */
54      public DimensionMismatchException(int wrong,
55                                        int expected) {
56          this(LocalizedFormats.DIMENSIONS_MISMATCH_SIMPLE, wrong, expected);
57      }
58  
59      /**
60       * @return the expected dimension.
61       */
62      public int getDimension() {
63          return dimension;
64      }
65  }