    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.Localizable;
    020    import org.apache.commons.math3.exception.util.ExceptionContext;
    021    import 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     * @version $Id: MathIllegalArgumentException.java 1364378 2012-07-22 17:42:38Z tn $
    031     */
    032    public class MathIllegalArgumentException extends IllegalArgumentException
    033        implements ExceptionContextProvider {
    034        /** Serializable version Id. */
    035        private static final long serialVersionUID = -6024911025449780478L;
    036        /** Context. */
    037        private final ExceptionContext context;
    038
    039        /**
    040         * @param pattern Message pattern explaining the cause of the error.
    041         * @param args Arguments.
    042         */
    043        public MathIllegalArgumentException(Localizable pattern,
    044                                            Object ... args) {
    045            context = new ExceptionContext(this);
    046            context.addMessage(pattern, args);
    047        }
    048
    049        /** {@inheritDoc} */
    050        public ExceptionContext getContext() {
    051            return context;
    052        }
    053
    054        /** {@inheritDoc} */
    055        @Override
    056        public String getMessage() {
    057            return context.getMessage();
    058        }
    059
    060        /** {@inheritDoc} */
    061        @Override
    062        public String getLocalizedMessage() {
    063            return context.getLocalizedMessage();
    064        }
    065    }