1   /* Copyright 2002-2025 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  
19  import java.text.MessageFormat;
20  import java.text.ParseException;
21  import java.util.Locale;
22  
23  import org.hipparchus.exception.Localizable;
24  
25  /** Extension of {@link java.text.ParseException} with localized message.
26   * @since 7.1
27   */
28  public class OrekitParseException extends ParseException implements LocalizedException {
29  
30      /** Serializable UID. */
31      private static final long serialVersionUID = 20150611L;
32  
33      /** Format specifier (to be translated). */
34      private final Localizable specifier;
35  
36      /** Parts to insert in the format (no translation). */
37      private final Object[] parts;
38  
39      /** Create an exception with localized message.
40       * @param specifier format specifier (to be translated)
41       * @param parts parts to insert in the format (no translation)
42       */
43      public OrekitParseException(final Localizable specifier, final Object... parts) {
44          super("", 0);
45          this.specifier = specifier;
46          this.parts     = (parts == null) ? new Object[0] : parts.clone();
47      }
48  
49      /** {@inheritDoc} */
50      @Override
51      public String getMessage(final Locale locale) {
52          return buildMessage(locale);
53      }
54  
55      /** {@inheritDoc} */
56      @Override
57      public String getMessage() {
58          return buildMessage(Locale.US);
59      }
60  
61      /** {@inheritDoc} */
62      @Override
63      public String getLocalizedMessage() {
64          return buildMessage(Locale.getDefault());
65      }
66  
67      /** {@inheritDoc} */
68      @Override
69      public Localizable getSpecifier() {
70          return specifier;
71      }
72  
73      /** {@inheritDoc} */
74      @Override
75      public Object[] getParts() {
76          return parts.clone();
77      }
78  
79      /**
80       * Builds a message string by from a pattern and its arguments.
81       * @param locale Locale in which the message should be translated
82       * @return a message string
83       */
84      private String buildMessage(final Locale locale) {
85          return (specifier == null) ?
86                  "" :
87                  new MessageFormat(specifier.getLocalizedString(locale), locale).format(parts);
88      }
89  
90  }