001 /*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017 package org.apache.commons.math.exception;
018
019 import org.apache.commons.math.exception.util.LocalizedFormats;
020
021 /**
022 * Exception to be thrown when two dimensions differ.
023 *
024 * @since 2.2
025 * @version $Revision$ $Date$
026 */
027 public class DimensionMismatchException extends MathIllegalNumberException {
028
029 /** Serializable version Id. */
030 private static final long serialVersionUID = -8415396756375798143L;
031
032 /** Correct dimension. */
033 private final int dimension;
034
035 /**
036 * Construct an exception from the mismatched dimensions.
037 *
038 * @param wrong Wrong dimension.
039 * @param expected Expected dimension.
040 */
041 public DimensionMismatchException(int wrong,
042 int expected) {
043 super(LocalizedFormats.DIMENSIONS_MISMATCH_SIMPLE, wrong, expected);
044 dimension = expected;
045 }
046
047 /**
048 * @return the expected dimension.
049 */
050 public int getDimension() {
051 return dimension;
052 }
053 }