Package net.datafaker.idnumbers

Class IrishIdNumber

java.lang.Object

net.datafaker.idnumbers.IrishIdNumber

All Implemented Interfaces:

IdNumberGenerator

public class IrishIdNumber
extends Object
implements IdNumberGenerator

Generator for Irish Personal Public Service Numbers (PPSN).

The PPSN is a unique identifier used in Ireland for citizens and residents. This generator produces both valid and invalid PPSN codes according to official specifications:

• 7 numeric digits followed by one or two uppercase letters
• The check character is calculated using a Modulo 23 algorithm
• An optional suffix (A, B, H, W) may be added and affects the checksum calculation

Reference: PPSN code

Main methods:

• countryCode() Returns the ISO-2 country code ("IE")
• generateValid(BaseProviders) Generates a valid PPSN as a string
• generateInvalid(BaseProviders) Generates an invalid PPSN
• generateValid(BaseProviders, IdNumber.IdNumberRequest) Generates a valid PersonIdNumber object
• validateAndCheckModulo23(String) Validates a PPSN and checks its checksum

Constructor Summary

Constructors

Constructor	Description
IrishIdNumber()

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 faker)	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.)

Methods inherited from class java.lang.Object

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

Constructor Details

IrishIdNumber

public IrishIdNumber()

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.

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

generateValid

public String generateValid(BaseProviders faker)

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.