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