Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
NameType |
|
| 1.0;1 |
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</code> 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 | * @version $Id$ | |
27 | */ | |
28 | 51 | public enum NameType { |
29 | ||
30 | /** Ashkenazi family names */ | |
31 | 1 | ASHKENAZI("ash"), |
32 | ||
33 | /** Generic names and words */ | |
34 | 1 | GENERIC("gen"), |
35 | ||
36 | /** Sephardic family names */ | |
37 | 1 | SEPHARDIC("sep"); |
38 | ||
39 | private final String name; | |
40 | ||
41 | 3 | NameType(String name) { |
42 | 3 | this.name = name; |
43 | 3 | } |
44 | ||
45 | /** | |
46 | * Gets the short version of the name type. | |
47 | * | |
48 | * @return the NameType short string | |
49 | */ | |
50 | public String getName() { | |
51 | 232 | return this.name; |
52 | } | |
53 | } |