View Javadoc
1   /* Copyright 2002-2016 CS Systèmes d'Information
2    * Licensed to CS Systèmes d'Information (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    *   https://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.hipparchus.exception;
18  
19  import java.util.Locale;
20  
21  /** This interface specified methods implemented by localized exception classes.
22   * <p>
23   * This interface has been copied from the interface with the same name
24   * from Orekit.
25   * </p>
26   */
27  public interface LocalizedException {
28  
29      /** Gets the message in a specified locale.
30       * @param locale Locale in which the message should be translated
31       * @return localized message
32       */
33      String getMessage(Locale locale);
34  
35      /** Get the localizable specifier of the error message.
36       * @return localizable specifier of the error message
37       */
38      Localizable getSpecifier();
39  
40      /** Get the variable parts of the error message.
41       * @return a copy of the variable parts of the error message
42       */
43      Object[] getParts();
44  
45  }