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.clustering;
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 LocalizedClusteringFormats implements Localizable {
43  
44      /** EMPTY_CLUSTER_IN_K_MEANS. */
45      EMPTY_CLUSTER_IN_K_MEANS("empty cluster in k-means");
46  
47      /** Source English format. */
48      private final String sourceFormat;
49  
50      /** Simple constructor.
51       * @param sourceFormat source English format to use when no
52       * localized version is available
53       */
54      LocalizedClusteringFormats(final String sourceFormat) {
55          this.sourceFormat = sourceFormat;
56      }
57  
58      /** {@inheritDoc} */
59      @Override
60      public String getSourceString() {
61          return sourceFormat;
62      }
63  
64      /** {@inheritDoc} */
65      @Override
66      public String getLocalizedString(final Locale locale) {
67          return getLocalizedString("assets/" + LocalizedClusteringFormats.class.getName().replaceAll("\\.", "/"),
68                                    name(), locale);
69      }
70  
71  }