Package net.datafaker.providers.base

Class Locality

java.lang.Object

net.datafaker.providers.base.AbstractProvider<BaseProviders>

net.datafaker.providers.base.Locality

public class Locality
extends AbstractProvider<BaseProviders>

Generates random locales in different forms.

Since:

1.7.0

Field Summary

Fields inherited from class net.datafaker.providers.base.AbstractProvider

faker

Constructor Summary

Constructors

Constructor	Description
Locality(BaseProviders baseProviders)	Constructor for Locality class

Method Summary

Modifier and Type	Method	Description
List<String>	allSupportedLocales()	Retrieves list of all locales supported by Datafaker
List<String>	allSupportedLocales(Set<String> fileMasks)
String	displayName()	Select a locale at random and returns display name of the locale
String	localeString()
String	localeStringWithoutReplacement()
String	localeStringWithoutReplacement(Random random)	Select a locale at random without replacement.
String	localeStringWithRandom(Random random)	Select a locale at random with replacement

Methods inherited from class net.datafaker.providers.base.AbstractProvider

equals, getFaker, hashCode, resolve, resolve

Methods inherited from class java.lang.Object

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

Constructor Details

Locality

public Locality(BaseProviders baseProviders)

Constructor for Locality class

Method Details

allSupportedLocales

public List<String> allSupportedLocales()

Retrieves list of all locales supported by Datafaker

Returns:

a List of Strings with the name of the locale (eg. "es", "es-MX")

allSupportedLocales

public List<String> allSupportedLocales(Set<String> fileMasks)

displayName

public String displayName()

Select a locale at random and returns display name of the locale

Returns:

locale in the form: "English (United States) or English"

localeString

public String localeString()

Returns:

Randomly selected locale (eg. "es", "es-MX"). Locale is selected at random WITH replacement from all supported locales

localeStringWithRandom

public String localeStringWithRandom(Random random)

Select a locale at random with replacement

Parameters:

random - random number generator (can utilize seed for deterministic random selection)

Returns:

String of a randomly selected locale (eg. "es", "es-MX")

localeStringWithoutReplacement

public String localeStringWithoutReplacement()

Returns:

Randomly selected locale (eg. "es", "es-MX"). Locale is selected at random WITHOUT replacement from all supported locales

localeStringWithoutReplacement

public String localeStringWithoutReplacement(Random random)

Select a locale at random without replacement. This can be used to rotate through all supported locales

Parameters:

random - random number generator (can utilize seed for deterministic random selection)

Returns:

String of a randomly selected locale (eg. "es", "es-MX")