org.orekit.rugged.errors

Class RuggedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.orekit.rugged.errors.RuggedException

All Implemented Interfaces:

Serializable

public class RuggedException
extends Exception

This class is the base class for all specific exceptions thrown by the rugged library classes.

This class is heavily based on Orekit OrekitException, which is distributed under the terms of the Apache License V2.

Author:

Luc Maisonobe

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RuggedException(ExceptionContextProvider provider) Simple constructor.
RuggedException(Localizable specifier, Object... parts) Simple constructor.
RuggedException(Localizable message, Throwable cause) Simple constructor.
RuggedException(RuggedException exception) Copy constructor.
RuggedException(Throwable cause, Localizable specifier, Object... parts) Simple constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static RuntimeException	createInternalError(Throwable cause) Create an RuntimeException for an internal error.
String	getLocalizedMessage()
String	getMessage()
String	getMessage(Locale locale) Gets the message in a specified locale.
Object[]	getParts() Get the variable parts of the error message.
Localizable	getSpecifier() Get the localizable specifier of the error message.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RuggedException

public RuggedException(Localizable specifier,
               Object... parts)

Simple constructor. Build an exception with a translated and formatted message

Parameters:

specifier - format specifier (to be translated)

parts - parts to insert in the format (no translation)

RuggedException

public RuggedException(RuggedException exception)

Copy constructor.

Parameters:

exception - exception to copy from

RuggedException

public RuggedException(Localizable message,
               Throwable cause)

Simple constructor. Build an exception from a cause and with a specified message

Parameters:

message - descriptive message

cause - underlying cause

RuggedException

public RuggedException(Throwable cause,
               Localizable specifier,
               Object... parts)

Simple constructor. Build an exception from a cause and with a translated and formatted message

Parameters:

cause - underlying cause

specifier - format specifier (to be translated)

parts - parts to insert in the format (no translation)

RuggedException

public RuggedException(ExceptionContextProvider provider)

Simple constructor. Build an exception from an Apache Commons Math exception context context

Parameters:

provider - underlying exception context provider

Method Detail

getMessage

public String getMessage(Locale locale)

Gets the message in a specified locale.

Parameters:

locale - Locale in which the message should be translated

Returns:

localized message

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getLocalizedMessage

public String getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable

getSpecifier

public Localizable getSpecifier()

Get the localizable specifier of the error message.

Returns:

localizable specifier of the error message

getParts

public Object[] getParts()

Get the variable parts of the error message.

Returns:

a copy of the variable parts of the error message

createInternalError

public static RuntimeException createInternalError(Throwable cause)

Create an RuntimeException for an internal error.

Parameters:

cause - underlying cause

Returns:

an RuntimeException for an internal error