RuggedInternalError.java

/* Copyright 2013-2022 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;

import java.text.MessageFormat;
import java.util.Locale;

import org.hipparchus.exception.Localizable;
import org.hipparchus.exception.LocalizedException;


/** Extension of {@link java.lang.Runtime} with localized message for internal errors only.
 * @since 2.1
 */
public class RuggedInternalError extends RuntimeException implements LocalizedException {

    /** Serializable UID. */
    private static final long serialVersionUID = 20190305L;

    /** Format specifier (to be translated). */
    private final Localizable specifier = RuggedMessages.INTERNAL_ERROR;

    /** Parts to insert in the format (no translation). */
    private final String[] parts        = new String[] {
        "https://gitlab.orekit.org/orekit/rugged/issues"
    };

    /** Create an exception with localized message.
     * @param cause underlying cause
     */
    public RuggedInternalError(final Throwable cause) {
        super(cause);
    }

    /** {@inheritDoc} */
    @Override
    public String getMessage(final Locale locale) {
        return buildMessage(locale);
    }

    /** {@inheritDoc} */
    @Override
    public String getMessage() {
        return buildMessage(Locale.US);
    }

    /** {@inheritDoc} */
    @Override
    public String getLocalizedMessage() {
        return buildMessage(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
     * @return a message string
     */
    private String buildMessage(final Locale locale) {
        return new MessageFormat(specifier.getLocalizedString(locale), locale).format(parts);
    }

}