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.ode;
23
24 import java.util.Locale;
25 import java.util.MissingResourceException;
26 import java.util.ResourceBundle;
27
28 import org.hipparchus.exception.Localizable;
29 import org.hipparchus.exception.UTF8Control;
30
31 /**
32 * Enumeration for localized messages formats used in exceptions messages.
33 * <p>
34 * The constants in this enumeration represent the available
35 * formats as localized strings. These formats are intended to be
36 * localized using simple properties files, using the constant
37 * name as the key and the property value as the message format.
38 * The source English format is provided in the constants themselves
39 * to serve both as a reminder for developers to understand the parameters
40 * needed by each format, as a basis for translators to create
41 * localized properties files, and as a default format if some
42 * translation is missing.
43 * </p>
44 */
45 public enum LocalizedODEFormats implements Localizable {
46
47 /** HOLE_BETWEEN_MODELS_TIME_RANGES. */
48 HOLE_BETWEEN_MODELS_TIME_RANGES("{0} wide hole between models time ranges"),
49
50 /** INTEGRATION_METHOD_NEEDS_AT_LEAST_TWO_PREVIOUS_POINTS. */
51 INTEGRATION_METHOD_NEEDS_AT_LEAST_TWO_PREVIOUS_POINTS("multistep method needs at least {0} previous steps, got {1}"),
52
53 /** MINIMAL_STEPSIZE_REACHED_DURING_INTEGRATION. */
54 MINIMAL_STEPSIZE_REACHED_DURING_INTEGRATION("minimal step size ({1,number,0.00E00}) reached, integration needs {0,number,0.00E00}"),
55
56 /** MULTISTEP_STARTER_STOPPED_EARLY. */
57 MULTISTEP_STARTER_STOPPED_EARLY("multistep integrator starter stopped early, maybe too large step size"),
58
59 /** PROPAGATION_DIRECTION_MISMATCH. */
60 PROPAGATION_DIRECTION_MISMATCH("propagation direction mismatch"),
61
62 /** TOO_SMALL_INTEGRATION_INTERVAL. */
63 TOO_SMALL_INTEGRATION_INTERVAL("too small integration interval: length = {0}"),
64
65 /** UNKNOWN_PARAMETER. */
66 UNKNOWN_PARAMETER("unknown parameter {0}"),
67
68 /** UNMATCHED_ODE_IN_EXPANDED_SET. */
69 UNMATCHED_ODE_IN_EXPANDED_SET("ode does not match the main ode set in the extended set"),
70
71 /** NAN_APPEARING_DURING_INTEGRATION. */
72 NAN_APPEARING_DURING_INTEGRATION("NaN appears during integration near time {0}"),
73
74 /** FIND_ROOT. */
75 FIND_ROOT("{0} failed to find root between {1} (g={2,number,0.0##############E0}) and {3} (g={4,number,0.0##############E0})\nLast iteration at {5} (g={6,number,0.0##############E0})");
76
77 /** Source English format. */
78 private final String sourceFormat;
79
80 /** Simple constructor.
81 * @param sourceFormat source English format to use when no
82 * localized version is available
83 */
84 LocalizedODEFormats(final String sourceFormat) {
85 this.sourceFormat = sourceFormat;
86 }
87
88 /** {@inheritDoc} */
89 @Override
90 public String getSourceString() {
91 return sourceFormat;
92 }
93
94 /** {@inheritDoc} */
95 @Override
96 public String getLocalizedString(final Locale locale) {
97 try {
98 final String path = LocalizedODEFormats.class.getName().replaceAll("\\.", "/");
99 ResourceBundle bundle =
100 ResourceBundle.getBundle("assets/" + path, locale, new UTF8Control());
101 if (bundle.getLocale().getLanguage().equals(locale.getLanguage())) {
102 final String translated = bundle.getString(name());
103 if ((translated != null) &&
104 (translated.length() > 0) &&
105 (!translated.toLowerCase(locale).contains("missing translation"))) {
106 // the value of the resource is the translated format
107 return translated;
108 }
109 }
110
111 } catch (MissingResourceException mre) { // NOPMD
112 // do nothing here
113 }
114
115 // either the locale is not supported or the resource is unknown
116 // don't translate and fall back to using the source format
117 return sourceFormat;
118
119 }
120
121 }