Package net.datafaker.idnumbers

Class AmericanIdNumber

java.lang.Object

net.datafaker.idnumbers.AmericanIdNumber

All Implemented Interfaces:

IdNumberGenerator

public class AmericanIdNumber
extends Object
implements IdNumberGenerator

Constructor Summary

Constructors

Constructor	Description
AmericanIdNumber()

Method Summary

Modifier and Type	Method	Description
String	countryCode()	ISO-2 code of the country this generator provides ID numbers for
String	generateInvalid(BaseProviders faker)	Generates an invalid ID number for given country (a.k.a.
String	generateValid(BaseProviders f)	Generates a valid ID number for given country (a.k.a.
PersonIdNumber	generateValid(BaseProviders faker, IdNumber.IdNumberRequest request)	Generates a valid ID number for given country corresponding to given criterias (age range, gender etc.)
String	getValidSsn(BaseProviders f)	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Details

AmericanIdNumber

public AmericanIdNumber()

Method Details

countryCode

public String countryCode()

Description copied from interface: IdNumberGenerator

ISO-2 code of the country this generator provides ID numbers for

Specified by:

countryCode in interface IdNumberGenerator

Returns:

e.g. "US" for America, "EE" for Estonia, "MD" for Moldova etc.

getValidSsn

@Deprecated
public String getValidSsn(BaseProviders f)

Deprecated.

generateValid

public String generateValid(BaseProviders f)

Description copied from interface: IdNumberGenerator

Generates a valid ID number for given country (a.k.a. "SSN", "Personal code" etc.)

Specified by:

generateValid in interface IdNumberGenerator

generateValid

public PersonIdNumber generateValid(BaseProviders faker,
 IdNumber.IdNumberRequest request)

Description copied from interface: IdNumberGenerator

Generates a valid ID number for given country corresponding to given criterias (age range, gender etc.)

Specified by:

generateValid in interface IdNumberGenerator

Returns:

PersonIdNumber containing a valid combination of ID, Birthday and Gender. In countries where ID number doesn't contain gender and/or birthday, the latter values are just random.

generateInvalid

public String generateInvalid(BaseProviders faker)

Description copied from interface: IdNumberGenerator

Generates an invalid ID number for given country (a.k.a. "SSN", "Personal code" etc.)

Specified by:

generateInvalid in interface IdNumberGenerator