Package net.datafaker.idnumbers

Interface IdNumberGenerator

All Known Implementing Classes:
AlbanianIdNumber, AmericanIdNumber, BrazilIdNumber, BulgarianIdNumber, ChineseIdNumber, EstonianIdNumber, FrenchIdNumber, GeorgianIdNumber, HungarianIdNumber, IrishIdNumber, ItalianIdNumber, LatvianIdNumber, MacedonianIdNumber, MexicanIdNumber, MoldovanIdNumber, NorwegianIdNumber, PolishIdNumber, PortugueseIdNumber, RomanianIdNumber, SingaporeIdNumber, SouthAfricanIdNumber, SouthKoreanIdNumber, SwedenIdNumber, UkrainianIdNumber
public interface IdNumberGenerator

  • Method Details

    • countryCode

      String countryCode()
      ISO-2 code of the country this generator provides ID numbers for
      Returns:
      e.g. "US" for America, "EE" for Estonia, "MD" for Moldova etc.

    • generateValid

      default String generateValid(BaseProviders faker)
      Generates a valid ID number for given country (a.k.a. "SSN", "Personal code" etc.)

    • generateInvalid

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

    • generateValid

      PersonIdNumber generateValid(BaseProviders faker, IdNumber.IdNumberRequest request)
      Generates a valid ID number for given country corresponding to given criterias (age range, gender etc.)
      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.