EnglishNameParser

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.screenscraper.util.parsing.name.EnglishNameParser

All Implemented Interfaces:

NameParser
```
@RequiredVersion(value=1)
public class EnglishNameParser
extends java.lang.Object
implements NameParser
```
English name parser. Instances of this class are immutable. The logic for white and black lists for names is as follows:
If white list and black list have elements, names must be both white listed and not black listed.
If neither are defined, everything is valid
If only white list is defined, the name must be white listed
If only black list is defined, the name must not be black listed

Version:

1.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EnglishNameParser.Builder
Builder class used to build parsers for english names.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.Set<java.lang.String>`	`ALL_HONORIFICS` A set of all honorifics (or honorifics).
`static java.util.Set<java.lang.String>`	`ALL_SUFFIXES` A set of all suffixes I can think of.
`static java.util.Set<java.lang.String>`	`DEFAULT_GENERATIONAL_SUFFIXES` A set of all suffixes I can think of.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

Name parse(java.lang.String name)
Method that parses a name.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ALL_HONORIFICS
```
public static final java.util.Set<java.lang.String> ALL_HONORIFICS
```
    A set of all honorifics (or honorifics). The default set used is a subset of this one
  - ALL_SUFFIXES
```
public static final java.util.Set<java.lang.String> ALL_SUFFIXES
```
    A set of all suffixes I can think of. This set is not used by default as it contains suffixes that could also be someone's name
  - DEFAULT_GENERATIONAL_SUFFIXES
```
public static final java.util.Set<java.lang.String> DEFAULT_GENERATIONAL_SUFFIXES
```
    A set of all suffixes I can think of. This set is not used by default as it contains suffixes that could also be someone's name
- Method Detail
  - parse
```
public Name parse(@NotNull
                  java.lang.String name)
           throws java.text.ParseException
```
    Description copied from interface: NameParser
    
    Method that parses a name. It will convert the string to a Name that can then be used elsewhere
    
    Specified by:
    
    parse in interface NameParser
    
    Parameters:
    
    name - The string representation of the name
    
    Returns:
    
    The Name object that was parsed. If the name fails to parse but no meaningful reason is given, null may be returned instead of throwing an exception
    
    Throws:
    
    java.text.ParseException - If there is an error parsing the name

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method