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.Localizable;
020import org.apache.commons.math3.exception.util.ExceptionContext;
021import org.apache.commons.math3.exception.util.ExceptionContextProvider;
022
023/**
024 * Base class for all preconditions violation exceptions.
025 * In most cases, this class should not be instantiated directly: it should
026 * serve as a base class to create all the exceptions that have the semantics
027 * of the standard {@link IllegalArgumentException}.
028 *
029 * @since 2.2
030 */
031public class MathIllegalArgumentException extends IllegalArgumentException
032    implements ExceptionContextProvider {
033    /** Serializable version Id. */
034    private static final long serialVersionUID = -6024911025449780478L;
035    /** Context. */
036    private final ExceptionContext context;
037
038    /**
039     * @param pattern Message pattern explaining the cause of the error.
040     * @param args Arguments.
041     */
042    public MathIllegalArgumentException(Localizable pattern,
043                                        Object ... args) {
044        context = new ExceptionContext(this);
045        context.addMessage(pattern, args);
046    }
047
048    /** {@inheritDoc} */
049    public ExceptionContext getContext() {
050        return context;
051    }
052
053    /** {@inheritDoc} */
054    @Override
055    public String getMessage() {
056        return context.getMessage();
057    }
058
059    /** {@inheritDoc} */
060    @Override
061    public String getLocalizedMessage() {
062        return context.getLocalizedMessage();
063    }
064}