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 * 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 */
032public class MathRuntimeException extends RuntimeException
033    implements ExceptionContextProvider {
034    /** Serializable version Id. */
035    private static final long serialVersionUID = 20120926L;
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 MathRuntimeException(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}