Source code
Description: source: package: org.apache.commons.codec.language.bm, enum: RuleType

    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 *      https://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 * Enumerates the types of rule.
    022 *
    023 * @since 1.6
    024 */
    025public enum RuleType {
    026
    027    /**
    028     * Approximate rules, which will lead to the largest number of phonetic interpretations.
    029     */
    030    APPROX("approx"),
    031
    032    /**
    033     * Exact rules, which will lead to a minimum number of phonetic interpretations.
    034     */
    035    EXACT("exact"),
    036
    037    /**
    038     * For internal use only. Please use {@link #APPROX} or {@link #EXACT}.
    039     */
    040    RULES("rules");
    041
    042    private final String name;
    043
    044    RuleType(final String name) {
    045        this.name = name;
    046    }
    047
    048    /**
    049     * Gets the rule name.
    050     *
    051     * @return The rule name.
    052     */
    053    public String getName() {
    054        return this.name;
    055    }
    056
    057}