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 supported types of names. Unless you are matching particular family names, use {@link #GENERIC}. The {@code GENERIC} NameType should work
022 * reasonably well for non-name words. The other encodings are specifically tuned to family names, and may not work well at all for general text.
023 *
024 * @since 1.6
025 */
026public enum NameType {
027
028    /**
029     * Ashkenazi family names.
030     */
031    ASHKENAZI("ash"),
032
033    /**
034     * Generic names and words.
035     */
036    GENERIC("gen"),
037
038    /**
039     * Sephardic family names.
040     */
041    SEPHARDIC("sep");
042
043    private final String name;
044
045    NameType(final String name) {
046        this.name = name;
047    }
048
049    /**
050     * Gets the short version of the name type.
051     *
052     * @return the NameType short string.
053     */
054    public String getName() {
055        return this.name;
056    }
057}