View Javadoc
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  
26  import org.hipparchus.exception.Localizable;
27  
28  /**
29   * Enumeration for localized messages formats used in exceptions messages.
30   * <p>
31   * The constants in this enumeration represent the available
32   * formats as localized strings. These formats are intended to be
33   * localized using simple properties files, using the constant
34   * name as the key and the property value as the message format.
35   * The source English format is provided in the constants themselves
36   * to serve both as a reminder for developers to understand the parameters
37   * needed by each format, as a basis for translators to create
38   * localized properties files, and as a default format if some
39   * translation is missing.
40   * </p>
41   */
42  public enum LocalizedODEFormats implements Localizable {
43  
44      /** HOLE_BETWEEN_MODELS_TIME_RANGES. */
45      HOLE_BETWEEN_MODELS_TIME_RANGES("{0} wide hole between models time ranges"),
46  
47      /** INTEGRATION_METHOD_NEEDS_AT_LEAST_TWO_PREVIOUS_POINTS. */
48      INTEGRATION_METHOD_NEEDS_AT_LEAST_TWO_PREVIOUS_POINTS("multistep method needs at least {0} previous steps, got {1}"),
49  
50      /** MINIMAL_STEPSIZE_REACHED_DURING_INTEGRATION. */
51      MINIMAL_STEPSIZE_REACHED_DURING_INTEGRATION("minimal step size ({1,number,0.00E00}) reached, integration needs {0,number,0.00E00}"),
52  
53      /** MULTISTEP_STARTER_STOPPED_EARLY. */
54      MULTISTEP_STARTER_STOPPED_EARLY("multistep integrator starter stopped early, maybe too large step size"),
55  
56      /** PROPAGATION_DIRECTION_MISMATCH. */
57      PROPAGATION_DIRECTION_MISMATCH("propagation direction mismatch"),
58  
59      /** TOO_SMALL_INTEGRATION_INTERVAL. */
60      TOO_SMALL_INTEGRATION_INTERVAL("too small integration interval: length = {0}"),
61  
62      /** UNKNOWN_PARAMETER. */
63      UNKNOWN_PARAMETER("unknown parameter {0}"),
64  
65      /** UNMATCHED_ODE_IN_EXPANDED_SET. */
66      UNMATCHED_ODE_IN_EXPANDED_SET("ode does not match the main ode set in the extended set"),
67  
68      /** NAN_APPEARING_DURING_INTEGRATION. */
69      NAN_APPEARING_DURING_INTEGRATION("NaN appears during integration near time {0}"),
70  
71      /** FIND_ROOT. */
72      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})");
73  
74      /** Source English format. */
75      private final String sourceFormat;
76  
77      /** Simple constructor.
78       * @param sourceFormat source English format to use when no
79       * localized version is available
80       */
81      LocalizedODEFormats(final String sourceFormat) {
82          this.sourceFormat = sourceFormat;
83      }
84  
85      /** {@inheritDoc} */
86      @Override
87      public String getSourceString() {
88          return sourceFormat;
89      }
90  
91      /** {@inheritDoc} */
92      @Override
93      public String getLocalizedString(final Locale locale) {
94          return getLocalizedString("assets/" + LocalizedODEFormats.class.getName().replaceAll("\\.", "/"),
95                                    name(), locale);
96      }
97  
98  }