RuggedExceptionWrapper.java

/* Copyright 2013-2020 CS GROUP
 * Licensed to CS GROUP (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.rugged.errors;

/** This class allows to wrap {@link RuggedException} instances in {@code RuntimeException}.
 * <p>Wrapping {@link RuggedException} instances is useful when a low level method throws
 * one such exception and this method must be called from another one which does not allow
 * this exception. Typical examples are propagation methods that are used inside Hipparchus
 * optimizers, integrators or solvers.</p>
 * <p>
 * This class is heavily based on {@code OrekitException},
 * which is distributed under the terms of the Apache License V2.
 * </p>
 * @author Luc Maisonobe
 * @author Guylaine Prat
 * @deprecated as of 2.1, this class is not used anymore, as {@link RuggedException}
 * is now an unchecked exception
 */
@Deprecated
public class RuggedExceptionWrapper extends RuntimeException {

    /** serializable UID. */
    private static final long serialVersionUID = 20150224L;

    /** Underlying Orekit exception. */
    private final RuggedException wrappedException;

    /** Simple constructor.
     * @param wrappedException Orekit exception to wrap
     */
    public RuggedExceptionWrapper(final RuggedException wrappedException) {
        super(wrappedException);
        this.wrappedException = wrappedException;
    }

    /** Get the wrapped exception.
     * @return wrapped exception
     */
    public RuggedException getException() {
        return wrappedException;
    }

}