no.kantega.id.fin

Class FinnishIdNumber

java.lang.Object

no.kantega.id.api.IdNumber

no.kantega.id.api.LocalIdNumber

no.kantega.id.fin.FinnishIdNumber

public class FinnishIdNumber
extends LocalIdNumber

Representation of ID number in Finland.

Field Summary

Fields inherited from class no.kantega.id.api.IdNumber

idToken

Constructor Summary

Constructors

Constructor and Description
FinnishIdNumber(String idToken)
FinnishIdNumber(String idToken, Locale locale)

Method Summary

Modifier and Type	Method and Description
static Optional<LocalDate>	birthday(IdNumber idNumber) Calculates optional birthday for the given idNumber.
static FinnishIdNumber	forId(String idToken) Provide an instance of IdNumber with Finnish locale (country Finland) and implementation for methods of IdNumber.
static FinnishIdNumber	forId(String idToken, Locale locale) Provide an instance of IdNumber with given locale (country Finland is only supported) and implementation for methods of IdNumber.
static Optional<Gender>	gender(IdNumber idNumber) Extracts the optional gender from the given IdNumber following the specification for Finnish national identity number.
protected boolean	supports(Locale locale) Defines support method for given locale.
static boolean	valid(IdNumber idNumber) Standard implementation of validity check for Finnish idNumbers.

Methods inherited from class no.kantega.id.api.IdNumber

age, birthday, gender, getIdToken, isValid

Methods inherited from class java.lang.Object

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

Constructor Detail

FinnishIdNumber

public FinnishIdNumber(String idToken)

FinnishIdNumber

public FinnishIdNumber(String idToken,
                       Locale locale)

Method Detail

forId

public static FinnishIdNumber forId(String idToken)

Provide an instance of IdNumber with Finnish locale (country Finland) and implementation for methods of IdNumber.

Parameters:

idToken - of idNumber.

Returns:

instance of FinnishIdNumber with locale set to "fi_FI".

forId

public static FinnishIdNumber forId(String idToken,
                                    Locale locale)

Provide an instance of IdNumber with given locale (country Finland is only supported) and implementation for methods of IdNumber.

Parameters:

idToken - of idNumber.

locale - for idNumber, must be supported.

Returns:

instance of FinnishIdNumber.

Throws:

IllegalArgumentException - if locale is not supported. This class supports only locales with country set as Finland.

gender

public static Optional<Gender> gender(IdNumber idNumber)

Extracts the optional gender from the given IdNumber following the specification for Finnish national identity number. Note that this method doesn't check the validity of the idNumber, it merely extracts gender part of idNumber and interprets it.

Parameters:

idNumber - where gender is taken from.

Returns:

Optional gender (male or female), or empty in case of non-digit gender bit.

valid

public static boolean valid(IdNumber idNumber)

Standard implementation of validity check for Finnish idNumbers. Valid idnumber is expected to follow format: ddMMyy[-|+|A]DDDX where 6 first characters represent birthday, followed by +, -, or A representing century (1800, 1900 or 2000), followed by 3-digit running number and control character.

Parameters:

idNumber - The idNumber to validate.

Returns:

true when valid id number, based on a given specification for Finland.

birthday

public static Optional<LocalDate> birthday(IdNumber idNumber)

Calculates optional birthday for the given idNumber. Calculation is based on the 7 first characters of idNumber from where the 6 first are birth date in format (ddMMyy), and the 7th character represents century.

Parameters:

idNumber - where birthday is calculated from.

Returns:

optional birthdate, or empty in case of invalid format.

supports

protected boolean supports(Locale locale)

Description copied from class: LocalIdNumber

Defines support method for given locale. Users of this class are supposed to override this method.

Overrides:

supports in class LocalIdNumber

Parameters:

locale - given locale.

Returns:

true if locale is supported, false otherwise.