/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.math3.exception;
import org.apache.commons.math3.exception.util.Localizable;
import org.apache.commons.math3.exception.util.LocalizedFormats;
import org.apache.commons.math3.exception.util.ExceptionContext;
import org.apache.commons.math3.exception.util.ExceptionContextProvider;
/**
* Base class for all exceptions that signal a mismatch between the
* current state and the user's expectations.
*
* @since 2.2
* @version $Id: MathIllegalStateException.java 1364378 2012-07-22 17:42:38Z tn $
*/
public class MathIllegalStateException extends IllegalStateException
implements ExceptionContextProvider {
/** Serializable version Id. */
private static final long serialVersionUID = -6024911025449780478L;
/** Context. */
private final ExceptionContext context;
/**
* Simple constructor.
*
* @param pattern Message pattern explaining the cause of the error.
* @param args Arguments.
*/
public MathIllegalStateException(Localizable pattern,
Object ... args) {
context = new ExceptionContext(this);
context.addMessage(pattern, args);
}
/**
* Simple constructor.
*
* @param cause Root cause.
* @param pattern Message pattern explaining the cause of the error.
* @param args Arguments.
*/
public MathIllegalStateException(Throwable cause,
Localizable pattern,
Object ... args) {
super(cause);
context = new ExceptionContext(this);
context.addMessage(pattern, args);
}
/**
* Default constructor.
*/
public MathIllegalStateException() {
this(LocalizedFormats.ILLEGAL_STATE);
}
/** {@inheritDoc} */
public ExceptionContext getContext() {
return context;
}
/** {@inheritDoc} */
@Override
public String getMessage() {
return context.getMessage();
}
/** {@inheritDoc} */
@Override
public String getLocalizedMessage() {
return context.getLocalizedMessage();
}
}