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 */
017package org.apache.commons.math3.exception;
018
019import org.apache.commons.math3.exception.util.ExceptionContextProvider;
020import org.apache.commons.math3.exception.util.LocalizedFormats;
021
022/**
023 * Class to signal parse failures.
024 *
025 * @since 2.2
026 */
027public class MathParseException extends MathIllegalStateException
028    implements ExceptionContextProvider {
029    /** Serializable version Id. */
030    private static final long serialVersionUID = -6024911025449780478L;
031
032    /**
033     * @param wrong Bad string representation of the object.
034     * @param position Index, in the {@code wrong} string, that caused the
035     * parsing to fail.
036     * @param type Class of the object supposedly represented by the
037     * {@code wrong} string.
038     */
039    public MathParseException(String wrong,
040                              int position,
041                              Class<?> type) {
042        getContext().addMessage(LocalizedFormats.CANNOT_PARSE_AS_TYPE,
043                                wrong, Integer.valueOf(position), type.getName());
044    }
045
046    /**
047     * @param wrong Bad string representation of the object.
048     * @param position Index, in the {@code wrong} string, that caused the
049     * parsing to fail.
050     */
051    public MathParseException(String wrong,
052                              int position) {
053        getContext().addMessage(LocalizedFormats.CANNOT_PARSE,
054                                wrong, Integer.valueOf(position));
055    }
056}