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 * http://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 18 package org.apache.commons.codec.language.bm; 19 20 /** 21 * Supported types of names. Unless you are matching particular family names, use {@link #GENERIC}. The 22 * {@code GENERIC} NameType should work reasonably well for non-name words. The other encodings are 23 * specifically tuned to family names, and may not work well at all for general text. 24 * 25 * @since 1.6 26 */ 27 public enum NameType { 28 29 /** 30 * Ashkenazi family names. 31 */ 32 ASHKENAZI("ash"), 33 34 /** 35 * Generic names and words. 36 */ 37 GENERIC("gen"), 38 39 /** 40 * Sephardic family names. 41 */ 42 SEPHARDIC("sep"); 43 44 private final String name; 45 46 NameType(final String name) { 47 this.name = name; 48 } 49 50 /** 51 * Gets the short version of the name type. 52 * 53 * @return the NameType short string 54 */ 55 public String getName() { 56 return this.name; 57 } 58 }