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     * As of release 4.0, all exceptions thrown by the Commons Math code (except
025     * {@link NullArgumentException}) inherit from this class.
026     * In most cases, this class should not be instantiated directly: it should
027     * serve as a base class for implementing exception classes that describe a
028     * specific "problem".
029     *
030     * @since 3.1
031     * @version $Id: MathRuntimeException.java 1416643 2012-12-03 19:37:14Z tn $
032     */
033    public class MathRuntimeException extends RuntimeException
034        implements ExceptionContextProvider {
035        /** Serializable version Id. */
036        private static final long serialVersionUID = 20120926L;
037        /** Context. */
038        private final ExceptionContext context;
039    
040        /**
041         * @param pattern Message pattern explaining the cause of the error.
042         * @param args Arguments.
043         */
044        public MathRuntimeException(Localizable pattern,
045                                    Object ... args) {
046            context = new ExceptionContext(this);
047            context.addMessage(pattern, args);
048        }
049    
050        /** {@inheritDoc} */
051        public ExceptionContext getContext() {
052            return context;
053        }
054    
055        /** {@inheritDoc} */
056        @Override
057        public String getMessage() {
058            return context.getMessage();
059        }
060    
061        /** {@inheritDoc} */
062        @Override
063        public String getLocalizedMessage() {
064            return context.getLocalizedMessage();
065        }
066    }