OrekitException.java
/* Copyright 2002-2016 CS Systèmes d'Information
* Licensed to CS Systèmes d'Information (CS) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* CS 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.orekit.errors;
import java.text.MessageFormat;
import java.util.Locale;
import org.apache.commons.math3.exception.util.ExceptionContext;
import org.apache.commons.math3.exception.util.ExceptionContextProvider;
import org.apache.commons.math3.exception.util.Localizable;
/** This class is the base class for all specific exceptions thrown by
* the orekit classes.
* <p>When the orekit classes throw exceptions that are specific to
* the package, these exceptions are always subclasses of
* OrekitException. When exceptions that are already covered by the
* standard java API should be thrown, like
* ArrayIndexOutOfBoundsException or InvalidParameterException, these
* standard exceptions are thrown rather than the commons-math specific
* ones.</p>
* <p>This class also provides utility methods to throw some standard
* java exceptions with localized messages.</p>
*
* @author Luc Maisonobe
*/
public class OrekitException extends Exception implements LocalizedException {
/** Serializable UID. */
private static final long serialVersionUID = 20150611L;
/** Exception context (may be null). */
private final ExceptionContext context;
/** Format specifier (to be translated). */
private final Localizable specifier;
/** Parts to insert in the format (no translation). */
private final Object[] parts;
/** Simple constructor.
* Build an exception with a translated and formatted message
* @param specifier format specifier (to be translated)
* @param parts parts to insert in the format (no translation)
*/
public OrekitException(final Localizable specifier, final Object ... parts) {
this.context = null;
this.specifier = specifier;
this.parts = (parts == null) ? new Object[0] : parts.clone();
}
/** Copy constructor.
* @param exception exception to copy from
* @since 5.1
*/
public OrekitException(final OrekitException exception) {
super(exception);
this.context = exception.context;
this.specifier = exception.specifier;
this.parts = exception.parts.clone();
}
/** Simple constructor.
* Build an exception from a cause and with a specified message
* @param message descriptive message
* @param cause underlying cause
*/
public OrekitException(final Localizable message, final Throwable cause) {
super(cause);
this.context = null;
this.specifier = message;
this.parts = new Object[0];
}
/** Simple constructor.
* Build an exception from a cause and with a translated and formatted message
* @param cause underlying cause
* @param specifier format specifier (to be translated)
* @param parts parts to insert in the format (no translation)
*/
public OrekitException(final Throwable cause, final Localizable specifier,
final Object ... parts) {
super(cause);
this.context = null;
this.specifier = specifier;
this.parts = (parts == null) ? new Object[0] : parts.clone();
}
/** Simple constructor.
* Build an exception from an Apache Commons Math exception context context
* @param provider underlying exception context provider
* @since 6.0
*/
public OrekitException(final ExceptionContextProvider provider) {
super(provider.getContext().getThrowable());
this.context = provider.getContext();
this.specifier = null;
this.parts = new Object[0];
}
/** {@inheritDoc} */
@Override
public String getMessage(final Locale locale) {
return (context != null) ?
context.getMessage(locale) :
buildMessage(locale, specifier, parts);
}
/** {@inheritDoc} */
@Override
public String getMessage() {
return getMessage(Locale.US);
}
/** {@inheritDoc} */
@Override
public String getLocalizedMessage() {
return getMessage(Locale.getDefault());
}
/** {@inheritDoc} */
@Override
public Localizable getSpecifier() {
return specifier;
}
/** {@inheritDoc} */
@Override
public Object[] getParts() {
return parts.clone();
}
/**
* Builds a message string by from a pattern and its arguments.
* @param locale Locale in which the message should be translated
* @param specifier format specifier (to be translated)
* @param parts parts to insert in the format (no translation)
* @return a message string
*/
private static String buildMessage(final Locale locale, final Localizable specifier, final Object ... parts) {
return (specifier == null) ? "" : new MessageFormat(specifier.getLocalizedString(locale), locale).format(parts);
}
/** Create an {@link java.lang.IllegalArgumentException} with localized message.
* @param specifier format specifier (to be translated)
* @param parts parts to insert in the format (no translation)
* @return an {@link java.lang.IllegalArgumentException} that also implements
* @deprecated as of 7.1, replaced with {@link
* OrekitIllegalArgumentException#OrekitIllegalArgumentException(Localizable, Object...)}
*/
@Deprecated
public static OrekitIllegalArgumentException createIllegalArgumentException(final Localizable specifier,
final Object ... parts) {
return new OrekitIllegalArgumentException(specifier, parts);
}
/** Create an {@link java.lang.IllegalStateException} with localized message.
* @param specifier format specifier (to be translated)
* @param parts parts to insert in the format (no translation)
* @return an {@link java.lang.IllegalStateException} with localized message
* @deprecated as of 7.1, replaced with {@link
* OrekitIllegalStateException#OrekitIllegalStateException(Localizable, Object...)}
*/
@Deprecated
public static OrekitIllegalStateException createIllegalStateException(final Localizable specifier,
final Object ... parts) {
return new OrekitIllegalStateException(specifier, parts);
}
/** Create an {@link java.text.ParseException} with localized message.
* @param specifier format specifier (to be translated)
* @param parts parts to insert in the format (no translation)
* @return an {@link java.text.ParseException} with localized message
* @deprecated as of 7.1, replaced with {@link
* OrekitParseException#OrekitParseException(Localizable, Object...)}
*/
@Deprecated
public static OrekitParseException createParseException(final Localizable specifier,
final Object ... parts) {
return new OrekitParseException(specifier, parts);
}
/** Create an {@link java.lang.RuntimeException} for an internal error.
* @param cause underlying cause
* @return an {@link java.lang.RuntimeException} for an internal error
* @deprecated as of 7.1, replaced with {@link
* OrekitInternalError#OrekitInternalError(Throwable)}
*/
@Deprecated
public static RuntimeException createInternalError(final Throwable cause) {
return new OrekitInternalError(cause);
}
}