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