Class NameGenerator

java.lang.Object

NameGenerator

public class NameGenerator
extends Object

Name generator for characters.

Since:

2016-02-12

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	NameGenerator.NameData

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final int	BASE_PERCENT_FEMALE	Base percent chance for female name.
(package private) static NameGenerator	instance	The singleton class instance.
(package private) NameGenerator.NameData[]	nameList	The name list data.
(package private) static final String	NAMES_FILE	Name of file with names.
(package private) int	percentFemale	Chance for female name.
(package private) static final char[]	raceCodes	Array of available race codes.
(package private) static final char[]	sexCodes	Array of available sex codes.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NameGenerator()	Constructor (read from dedicated file).

Method Summary

Modifier and Type	Method	Description
static NameGenerator	getInstance()	Access the singleton class instance.
private char	getRaceCode(String s)	Convert race string to character code.
String	getRandom()	Get a random name of any type.
String	getRandom(char race)	Get a random name, given the race.
String	getRandom(char race, char sex)	Get a random name, given race and sex.
String	getRandom(String race)	Get a random name, given race by string.
private char	getRandomRace()	Get a random race identifier.
private boolean	isValidRace(char race)	Is this a valid race code?
private boolean	isValidSex(char sex)	Is this a valid sex code?
static void	main(String[] args)	Main test function.
void	setChanceFemale(int percent)	Set a new chance for female names.

Methods inherited from class java.lang.Object

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

Field Details

NAMES_FILE

static final String NAMES_FILE

Name of file with names.

See Also:

• Constant Field Values

raceCodes

static final char[] raceCodes

Array of available race codes.

sexCodes

static final char[] sexCodes

Array of available sex codes.

BASE_PERCENT_FEMALE

static final int BASE_PERCENT_FEMALE

Base percent chance for female name.

See Also:

• Constant Field Values

instance

static NameGenerator instance

The singleton class instance.

nameList

NameGenerator.NameData[] nameList

The name list data.

percentFemale

int percentFemale

Chance for female name.

Constructor Details

NameGenerator

protected NameGenerator()
                 throws IOException

Constructor (read from dedicated file).

Throws:

IOException

Method Details

getInstance

public static NameGenerator getInstance()

Access the singleton class instance.

setChanceFemale

public void setChanceFemale(int percent)

Set a new chance for female names.

getRandom

public String getRandom(char race,
 char sex)

Get a random name, given race and sex.

getRandom

public String getRandom(char race)

Get a random name, given the race.

getRandom

public String getRandom(String race)

Get a random name, given race by string.

getRandomRace

private char getRandomRace()

Get a random race identifier.

getRandom

public String getRandom()

Get a random name of any type.

isValidRace

private boolean isValidRace(char race)

Is this a valid race code?

isValidSex

private boolean isValidSex(char sex)

Is this a valid sex code?

getRaceCode

private char getRaceCode(String s)

Convert race string to character code.

main

public static void main(String[] args)

Main test function.