NameType.java

  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.  *      https://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. package org.apache.commons.codec.language.bm;

  18. /**
  19.  * Supported types of names. Unless you are matching particular family names, use {@link #GENERIC}. The
  20.  * {@code GENERIC} NameType should work reasonably well for non-name words. The other encodings are
  21.  * specifically tuned to family names, and may not work well at all for general text.
  22.  *
  23.  * @since 1.6
  24.  */
  25. public enum NameType {

  26.     /**
  27.      * Ashkenazi family names.
  28.      */
  29.     ASHKENAZI("ash"),

  30.     /**
  31.      * Generic names and words.
  32.      */
  33.     GENERIC("gen"),

  34.     /**
  35.      * Sephardic family names.
  36.      */
  37.     SEPHARDIC("sep");

  38.     private final String name;

  39.     NameType(final String name) {
  40.         this.name = name;
  41.     }

  42.     /**
  43.      * Gets the short version of the name type.
  44.      *
  45.      * @return the NameType short string
  46.      */
  47.     public String getName() {
  48.         return this.name;
  49.     }
  50. }