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    *      http://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  package org.apache.commons.codec.language.bm;
19  
20  /**
21   * Types of rule.
22   *
23   * @since 1.6
24   */
25  public enum RuleType {
26  
27      /**
28       * Approximate rules, which will lead to the largest number of phonetic interpretations.
29       */
30      APPROX("approx"),
31  
32      /**
33       * Exact rules, which will lead to a minimum number of phonetic interpretations.
34       */
35      EXACT("exact"),
36  
37      /**
38       * For internal use only. Please use {@link #APPROX} or {@link #EXACT}.
39       */
40      RULES("rules");
41  
42      private final String name;
43  
44      RuleType(final String name) {
45          this.name = name;
46      }
47  
48      /**
49       * Gets the rule name.
50       *
51       * @return the rule name.
52       */
53      public String getName() {
54          return this.name;
55      }
56  
57  }