OrekitIOException.java

  1. /* Copyright 2002-2024 CS GROUP
  2.  * Licensed to CS GROUP (CS) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * CS licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *   http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.orekit.errors;

  18. import java.io.IOException;
  19. import java.text.MessageFormat;
  20. import java.util.Locale;

  21. import org.hipparchus.exception.Localizable;

  22. /** Extension of {@link java.io.IOException} with localized message.
  23.  * @since 9.2
  24.  */
  25. public class OrekitIOException extends IOException implements LocalizedException {

  26.     /** Serializable UID. */
  27.     private static final long serialVersionUID = 20180427L;

  28.     /** Format specifier (to be translated). */
  29.     private final Localizable specifier;

  30.     /** Parts to insert in the format (no translation). */
  31.     private final Object[] parts;

  32.     /** Create an exception with localized message.
  33.      * @param specifier format specifier (to be translated)
  34.      * @param parts parts to insert in the format (no translation)
  35.      */
  36.     public OrekitIOException(final Localizable specifier, final Object... parts) {
  37.         this.specifier = specifier;
  38.         this.parts     = (parts == null) ? new Object[0] : parts.clone();
  39.     }

  40.     /** {@inheritDoc} */
  41.     @Override
  42.     public String getMessage(final Locale locale) {
  43.         return buildMessage(locale);
  44.     }

  45.     /** {@inheritDoc} */
  46.     @Override
  47.     public String getMessage() {
  48.         return buildMessage(Locale.US);
  49.     }

  50.     /** {@inheritDoc} */
  51.     @Override
  52.     public String getLocalizedMessage() {
  53.         return buildMessage(Locale.getDefault());
  54.     }

  55.     /** {@inheritDoc} */
  56.     @Override
  57.     public Localizable getSpecifier() {
  58.         return specifier;
  59.     }

  60.     /** {@inheritDoc} */
  61.     @Override
  62.     public Object[] getParts() {
  63.         return parts.clone();
  64.     }

  65.     /**
  66.      * Builds a message string by from a pattern and its arguments.
  67.      * @param locale Locale in which the message should be translated
  68.      * @return a message string
  69.      */
  70.     private String buildMessage(final Locale locale) {
  71.         return (specifier == null) ?
  72.                 "" :
  73.                 new MessageFormat(specifier.getLocalizedString(locale), locale).format(parts);
  74.     }

  75. }