no.kantega.id.api

Class IdNumber

java.lang.Object

no.kantega.id.api.IdNumber

Direct Known Subclasses:

LocalIdNumber

public class IdNumber
extends Object

Base class for implementations of an ID number. This class is not capable of understanding the meaning of any ID number but serves as a dispatcher for implementations of a country's ID number.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	idToken The ID number token for this instance.

Constructor Summary

Constructors

Constructor and Description
IdNumber(String idToken) Creates an immutable ID number.

Method Summary

Modifier and Type	Method and Description
Optional<Period>	age(Function<IdNumber,Optional<LocalDate>> birthDayFunction) Retrieves the age of the person holding this ID number as it is defined for a given birth day assertion.
Optional<LocalDate>	birthday(Function<IdNumber,Optional<LocalDate>> birthDayFunction) Retrieves the birth day of the person holding this ID number as it is defined for a given birth day assertion.
static IdNumber	forId(String idToken) Creates a new ID number for a given token.
Optional<Gender>	gender(Function<IdNumber,Optional<Gender>> genderFunction) Retrieves the gender of the person holding this ID number as it is defined for a given gender assertion.
String	getIdToken() Returns this ID number's token.
boolean	isValid(Predicate<IdNumber> validityTest) Checks if this ID number is valid for a given validity assertion.

Methods inherited from class java.lang.Object

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

Field Detail

idToken

protected final String idToken

The ID number token for this instance.

Constructor Detail

IdNumber

public IdNumber(String idToken)

Creates an immutable ID number.

Parameters:

idToken - The ID token to represent.

Method Detail

forId

public static IdNumber forId(String idToken)

Creates a new ID number for a given token.

Parameters:

idToken - The token to represent.

Returns:

The created ID number.

getIdToken

public String getIdToken()

Returns this ID number's token.

Returns:

The token represented by this ID number.

isValid

public boolean isValid(Predicate<IdNumber> validityTest)

Checks if this ID number is valid for a given validity assertion.

Parameters:

validityTest - An implementation of an ID number's validity assertion.

Returns:

true if this ID number is valid for the given assertion logic.

gender

public Optional<Gender> gender(Function<IdNumber,Optional<Gender>> genderFunction)

Retrieves the gender of the person holding this ID number as it is defined for a given gender assertion.

Parameters:

genderFunction - An implementation of an ID number's gender assertion.

Returns:

The gender represented by this ID number as valid for the given assertion logic.

birthday

public Optional<LocalDate> birthday(Function<IdNumber,Optional<LocalDate>> birthDayFunction)

Retrieves the birth day of the person holding this ID number as it is defined for a given birth day assertion.

Parameters:

birthDayFunction - An implementation of an ID number's birth day assertion.

Returns:

The birth day represented by this ID number as valid for the given assertion logic.

age

public Optional<Period> age(Function<IdNumber,Optional<LocalDate>> birthDayFunction)

Retrieves the age of the person holding this ID number as it is defined for a given birth day assertion.

Parameters:

birthDayFunction - An implementation of an ID number's birth day assertion.

Returns:

The age as represented by this ID number as valid for the given assertion logic.