diff options
Diffstat (limited to 'src/main/java/org/apache/commons/math/exception/MathIllegalStateException.java')
-rw-r--r-- | src/main/java/org/apache/commons/math/exception/MathIllegalStateException.java | 140 |
1 files changed, 140 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math/exception/MathIllegalStateException.java b/src/main/java/org/apache/commons/math/exception/MathIllegalStateException.java new file mode 100644 index 0000000..d4e83d4 --- /dev/null +++ b/src/main/java/org/apache/commons/math/exception/MathIllegalStateException.java @@ -0,0 +1,140 @@ +/* + * 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.math.exception; + +import java.util.Locale; + +import org.apache.commons.math.exception.util.ArgUtils; +import org.apache.commons.math.exception.util.MessageFactory; +import org.apache.commons.math.exception.util.Localizable; + +/** + * Base class for all exceptions that signal a mismatch between the + * current state and the user's expectations. + * + * @since 2.2 + * @version $Revision: 1061496 $ $Date: 2011-01-20 21:32:16 +0100 (jeu. 20 janv. 2011) $ + */ +public class MathIllegalStateException extends IllegalStateException implements MathThrowable { + + /** Serializable version Id. */ + private static final long serialVersionUID = -6024911025449780478L; + + /** + * Pattern used to build the message (specific context). + */ + private final Localizable specific; + /** + * Pattern used to build the message (general problem description). + */ + private final Localizable general; + /** + * Arguments used to build the message. + */ + private final Object[] arguments; + + /** + * Simple constructor. + * @param specific Message pattern providing the specific context of + * the error. + * @param general Message pattern explaining the cause of the error. + * @param args Arguments. + */ + public MathIllegalStateException(Localizable specific, + Localizable general, + Object ... args) { + this(null, specific, general, args); + } + + /** + * Simple constructor. + * @param cause root cause + * @param specific Message pattern providing the specific context of + * the error. + * @param general Message pattern explaining the cause of the error. + * @param args Arguments. + */ + public MathIllegalStateException(Throwable cause, + Localizable specific, + Localizable general, + Object ... args) { + super(cause); + this.specific = specific; + this.general = general; + arguments = ArgUtils.flatten(args); + } + + /** + * @param general Message pattern explaining the cause of the error. + * @param args Arguments. + */ + public MathIllegalStateException(Localizable general, + Object ... args) { + this(null, null, general, args); + } + + /** + * Simple constructor. + * @param cause root cause + * @param general Message pattern explaining the cause of the error. + * @param args Arguments. + */ + public MathIllegalStateException(Throwable cause, + Localizable general, + Object ... args) { + this(cause, null, general, args); + } + + /** {@inheritDoc} */ + public Localizable getSpecificPattern() { + return specific; + } + + /** {@inheritDoc} */ + public Localizable getGeneralPattern() { + return general; + } + + /** {@inheritDoc} */ + public Object[] getArguments() { + return arguments.clone(); + } + + /** + * Get the message in a specified locale. + * + * @param locale Locale in which the message should be translated. + * + * @return the localized message. + */ + public String getMessage(final Locale locale) { + return MessageFactory.buildMessage(locale, specific, general, arguments); + } + + /** {@inheritDoc} */ + @Override + public String getMessage() { + return getMessage(Locale.US); + } + + /** {@inheritDoc} */ + @Override + public String getLocalizedMessage() { + return getMessage(Locale.getDefault()); + } + +} |