Package com.minecolonies.api.colony

Class CitizenNameFile

java.lang.Object

com.minecolonies.api.colony.CitizenNameFile

public class CitizenNameFile
extends Object

The citizen name file of a specific style of names.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CitizenNameFile.NameOrder	Current types of name order.

Field Summary

Fields

Modifier and Type	Field	Description
List<String>	femalefirstNames	List of female first names.
List<String>	maleFirstNames	List of male first names.
CitizenNameFile.NameOrder	order	The order of the name (initially eastern and western).
int	parts	Number of parts the name consists of (usually 3 with middle initial or 2 without).
List<String>	surnames	List of surnames.

Constructor Summary

Constructors

Constructor	Description
CitizenNameFile(int parts, @NotNull CitizenNameFile.NameOrder order, @NotNull List<String> maleFirstNames, @NotNull List<String> femaleFirstNames, @NotNull List<String> surnames)	Create a new instance of a specific name file.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

parts

public int parts

Number of parts the name consists of (usually 3 with middle initial or 2 without).

order

public CitizenNameFile.NameOrder order

The order of the name (initially eastern and western).

maleFirstNames

public List<String> maleFirstNames

List of male first names.

femalefirstNames

public List<String> femalefirstNames

List of female first names.

surnames

public List<String> surnames

List of surnames.

Constructor Details

CitizenNameFile

public CitizenNameFile(int parts,
 @NotNull
 @NotNull CitizenNameFile.NameOrder order,
 @NotNull
 @NotNull List<String> maleFirstNames,
 @NotNull
 @NotNull List<String> femaleFirstNames,
 @NotNull
 @NotNull List<String> surnames)

Create a new instance of a specific name file.

Parameters:

parts - the number of parts.

order - the name order.

maleFirstNames - the male first names.

femaleFirstNames - the female first names.

surnames - the surnames.