com.screenscraper.util.parsing.name

Class Name

java.lang.Object

com.screenscraper.util.parsing.name.Name

public final class Name
extends java.lang.Object

Representation of a name

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
Name(java.util.List<java.lang.String> honorifics, java.lang.String firstName, java.util.List<java.lang.String> middleNames, java.lang.String lastName, java.util.Collection<java.lang.String> generationalSuffixes, java.util.Collection<java.lang.String> suffixes) Creates a name with all the specified parameters
Name(java.lang.String firstName, java.util.List<java.lang.String> middleNames, java.lang.String lastName) Creates a name with the given parameters
Name(java.lang.String firstName, java.lang.String lastName) Creates a simple name

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Collection<java.lang.String>	getAllSuffixes() Returns the generational and suffixes of the name
java.lang.String	getAllSuffixString() Returns the well formatted version of the suffixes (including generational suffixes)
java.lang.String	getFirstName() Gets the first name
java.lang.String	getFullName() Returns the full name (first, middle, last) without honorifics or suffixes (except generation suffixes)
java.util.Collection<java.lang.String>	getGenerationalSuffixes() Returns the generational suffixes of the name
java.lang.String	getGenerationalSuffixString() Returns the well formatted version of the suffixes (including generational suffixes)
java.util.List<java.lang.String>	getHonorifics() Gets the honorifics used in this name
java.lang.String	getLastName() Gets the last name
java.lang.String	getMiddleName() Gets the middle name(s) as a string.
java.util.List<java.lang.String>	getMiddleNames() Get the middle names
java.util.Collection<java.lang.String>	getSuffixes() Returns the suffixes of the name
java.lang.String	getSuffixString() Returns the well formatted version of the suffixes (excluding generational suffixes)
int	hashCode()
java.lang.String	toFormattedString() Returns the well formatted version of the entire name (complete with honorifics and suffixes)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Name

public Name(@Nullable
            java.lang.String firstName,
            @Nullable
            java.lang.String lastName)

Creates a simple name

Parameters:

firstName - The first name

lastName - The last name

Name

public Name(@Nullable
            java.lang.String firstName,
            @Nullable
            java.util.List<java.lang.String> middleNames,
            @Nullable
            java.lang.String lastName)

Creates a name with the given parameters

Parameters:

firstName - The first name

middleNames - The middle names

lastName - The last name

Name

public Name(@Nullable
            java.util.List<java.lang.String> honorifics,
            @Nullable
            java.lang.String firstName,
            @Nullable
            java.util.List<java.lang.String> middleNames,
            @Nullable
            java.lang.String lastName,
            @Nullable
            java.util.Collection<java.lang.String> generationalSuffixes,
            @Nullable
            java.util.Collection<java.lang.String> suffixes)

Creates a name with all the specified parameters

Parameters:

honorifics - The honorifics of the name, such as Honorary Judge

firstName - The first name

middleNames - A list, in order, of the middle names

lastName - The last name

generationalSuffixes - The generational suffixes for the name

suffixes - A collection of suffixes for the name

Method Detail

getFirstName

@Nullable
public java.lang.String getFirstName()

Gets the first name

Returns:

The first name

getLastName

@Nullable
public java.lang.String getLastName()

Gets the last name

Returns:

The last anme

getMiddleNames

@NotNull
public java.util.List<java.lang.String> getMiddleNames()

Get the middle names

Returns:

The middle names

getMiddleName

@Nullable
public java.lang.String getMiddleName()

Gets the middle name(s) as a string. If there is more than one name, each part will have a space between it

Returns:

The middle name(s) as a single string, or null if there are no middle names

getGenerationalSuffixes

@NotNull
public java.util.Collection<java.lang.String> getGenerationalSuffixes()

Returns the generational suffixes of the name

Returns:

The generational suffixes of the name

getSuffixes

@NotNull
public java.util.Collection<java.lang.String> getSuffixes()

Returns the suffixes of the name

Returns:

The suffixes of the name

getAllSuffixes

@NotNull
public java.util.Collection<java.lang.String> getAllSuffixes()

Returns the generational and suffixes of the name

Returns:

The generational and suffixes of the name

getHonorifics

@NotNull
public java.util.List<java.lang.String> getHonorifics()

Gets the honorifics used in this name

Returns:

The honorifics used in the name

getFullName

@NotNull
public java.lang.String getFullName()

Returns the full name (first, middle, last) without honorifics or suffixes (except generation suffixes)

Returns:

The full name

getSuffixString

@NotNull
public java.lang.String getSuffixString()

Returns the well formatted version of the suffixes (excluding generational suffixes)

Returns:

The well formatted version of the suffixes (excluding generational suffixes)

getGenerationalSuffixString

@NotNull
public java.lang.String getGenerationalSuffixString()

Returns the well formatted version of the suffixes (including generational suffixes)

Returns:

The well formatted version of the suffixes (including generational suffixes)

getAllSuffixString

@NotNull
public java.lang.String getAllSuffixString()

Returns the well formatted version of the suffixes (including generational suffixes)

Returns:

The well formatted version of the suffixes (including generational suffixes)

toFormattedString

@NotNull
public java.lang.String toFormattedString()

Returns the well formatted version of the entire name (complete with honorifics and suffixes)

Returns:

The well formatted version of the entire name

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object