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  
19  import java.util.Locale;
20  
21  import org.hipparchus.exception.Localizable;
22  
23  /** This interface specified methods implemented by localized exception classes.
24   * @author Luc Maisonobe
25   * @since 7.1
26   */
27  
28  public interface LocalizedException {
29  
30      /** Gets the message in a specified locale.
31       * @param locale Locale in which the message should be translated
32       * @return localized message
33       */
34      String getMessage(Locale locale);
35  
36      /** Get the localizable specifier of the error message.
37       * @return localizable specifier of the error message
38       */
39      Localizable getSpecifier();
40  
41      /** Get the variable parts of the error message.
42       * @return a copy of the variable parts of the error message
43       */
44      Object[] getParts();
45  
46  }