Home | History | Annotate | Download | only in exception
      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.math.exception;
     18 
     19 import org.apache.commons.math.exception.util.LocalizedFormats;
     20 
     21 /**
     22  * Exception to be thrown when two dimensions differ.
     23  *
     24  * @since 2.2
     25  * @version $Revision$ $Date$
     26  */
     27 public class DimensionMismatchException extends MathIllegalNumberException {
     28 
     29     /** Serializable version Id. */
     30     private static final long serialVersionUID = -8415396756375798143L;
     31 
     32     /** Correct dimension. */
     33     private final int dimension;
     34 
     35     /**
     36      * Construct an exception from the mismatched dimensions.
     37      *
     38      * @param wrong Wrong dimension.
     39      * @param expected Expected dimension.
     40      */
     41     public DimensionMismatchException(int wrong,
     42                                       int expected) {
     43         super(LocalizedFormats.DIMENSIONS_MISMATCH_SIMPLE, wrong, expected);
     44         dimension = expected;
     45     }
     46 
     47     /**
     48      * @return the expected dimension.
     49      */
     50     public int getDimension() {
     51         return dimension;
     52     }
     53 }
     54