Source code

    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017
    018package org.apache.commons.codec.language.bm;
    019
    020/**
    021 * Types of rule.
    022 *
    023 * @since 1.6
    024 * @version $Id: RuleType.java 1542813 2013-11-17 20:52:32Z tn $
    025 */
    026public enum RuleType {
    027
    028    /** Approximate rules, which will lead to the largest number of phonetic interpretations. */
    029    APPROX("approx"),
    030    /** Exact rules, which will lead to a minimum number of phonetic interpretations. */
    031    EXACT("exact"),
    032    /** For internal use only. Please use {@link #APPROX} or {@link #EXACT}. */
    033    RULES("rules");
    034
    035    private final String name;
    036
    037    RuleType(final String name) {
    038        this.name = name;
    039    }
    040
    041    /**
    042     * Gets the rule name.
    043     *
    044     * @return the rule name.
    045     */
    046    public String getName() {
    047        return this.name;
    048    }
    049
    050}