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.math3.exception;
018    
019    import org.apache.commons.math3.exception.util.LocalizedFormats;
020    import org.apache.commons.math3.exception.util.Localizable;
021    
022    /**
023     * Exception to be thrown when two dimensions differ.
024     *
025     * @since 2.2
026     * @version $Id: DimensionMismatchException.java 1364378 2012-07-22 17:42:38Z tn $
027     */
028    public class DimensionMismatchException extends MathIllegalNumberException {
029        /** Serializable version Id. */
030        private static final long serialVersionUID = -8415396756375798143L;
031        /** Correct dimension. */
032        private final int dimension;
033    
034        /**
035         * Construct an exception from the mismatched dimensions.
036         *
037         * @param specific Specific context information pattern.
038         * @param wrong Wrong dimension.
039         * @param expected Expected dimension.
040         */
041        public DimensionMismatchException(Localizable specific,
042                                          int wrong,
043                                          int expected) {
044            super(specific, wrong, expected);
045            dimension = expected;
046        }
047    
048        /**
049         * Construct an exception from the mismatched dimensions.
050         *
051         * @param wrong Wrong dimension.
052         * @param expected Expected dimension.
053         */
054        public DimensionMismatchException(int wrong,
055                                          int expected) {
056            this(LocalizedFormats.DIMENSIONS_MISMATCH_SIMPLE, wrong, expected);
057        }
058    
059        /**
060         * @return the expected dimension.
061         */
062        public int getDimension() {
063            return dimension;
064        }
065    }