1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF 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
18 /*
19 * This is not the original file distributed by the Apache Software Foundation
20 * It has been modified by the Hipparchus project
21 */
22 package org.hipparchus.exception;
23
24 import java.io.Serializable;
25 import java.util.Locale;
26 import java.util.MissingResourceException;
27 import java.util.ResourceBundle;
28
29 /**
30 * Interface for localizable strings.
31 *
32 */
33 public interface Localizable extends Serializable {
34 /**
35 * Gets the source (non-localized) string.
36 *
37 * @return the source string.
38 */
39 String getSourceString();
40
41 /**
42 * Gets the localized string.
43 *
44 * @param locale locale into which to get the string.
45 * @return the localized string or the source string if no
46 * localized version is available.
47 */
48 String getLocalizedString(Locale locale);
49
50 /**
51 * Gets the localized string.
52 *
53 * @param baseName base name of the resource bundle
54 * @param key key of the item in the bundle
55 * @param locale locale into which to get the string.
56 * @return the localized string or the source string if no
57 * localized version is available.
58 */
59 default String getLocalizedString(final String baseName, final String key, final Locale locale) {
60
61 try {
62 final ResourceBundle bundle = ResourceBundle.getBundle(baseName, locale, new UTF8Control());
63 if (bundle.getLocale().getLanguage().equals(locale.getLanguage()))
64 {
65 final String translated = bundle.getString(key);
66 if (!(translated.isEmpty() || translated.toLowerCase(locale).contains("missing translation")))
67 {
68 // the value of the resource is the translated format
69 return translated;
70 }
71 }
72 } catch (MissingResourceException mre) { // NOPMD
73 // do nothing here
74 }
75
76 // either the locale is not supported or the resource is not translated, or
77 // it is unknown: don't translate and fall back to using the source format
78 return getSourceString();
79
80 }
81
82 }