SwedishIdNumber (KantId 0.1 API)

java.lang.Object
- no.kantega.id.api.IdNumber
- - no.kantega.id.api.LocalIdNumber
  - - no.kantega.id.se.SwedishIdNumber

```
public class SwedishIdNumber
extends LocalIdNumber
```
Representation of a Swedish personnummer which is issued by the Swedish Skatteverket. Such a number is represented by ten digits and a hyphen which is inserted after the first six digits that represent a person's birthday. The birthday is represented in the format YYMMDD, where the year is only included by its last two digits. The hyphen is represented by:
1. A - sign: For people under the age of 100
2. A ß sign: For people that have reached the age of 100
In order to avoid a change of the ID number by reaching a certain age, some authorities use 12 digit numbers instead which represent the birthday in the format YYYYMMDD without using a hyphen. Both formats are understood by this implementation.
The remaining digits of the personnummer can interpreted differently:
1. Up to 1990 the seventh and eight digit represented the country of birth of a person or alternatively the country of residence, if a person was born before 1947.
2. The ninth digit represents a person's gender with even numbers being reserved for females and odd numbers for males.
3. After 1967, the tenth digit was used to represent a checksum. Before this year, the Swedish personnummer consisted of only 9 digits. The latter representation is not understood by this implementation.
The rule for computing a check sum to a personnummer is documented on for example Wikipedia.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SE_COUNTRY` A default country token for Sweden.
`static Locale`	`SWEDEN` A default Swedish locale.
`static String`	`VALID_FORMAT_SE` A regular expression for checking if a number is in the format of a Swedish ID number.

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

Constructor Summary

Constructors
Constructor and Description
`SwedishIdNumber(String idToken)` Creates a Swedish ID with default locale.
`SwedishIdNumber(String idToken, Locale locale)` Creates a new Swedish ID with the given locale.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<LocalDate>`	`birthday()` Determines the birth day of the person associated to this ID number, if applicable.
`static Optional<LocalDate>`	`birthday(IdNumber idNumber)` Calculates the birth date of the given IdNumber
`static SwedishIdNumber`	`forId(String token)` Provide an instance of IdNumber with Swedish locale and provides implementation of all the method supported.
`static SwedishIdNumber`	`forId(String token, Locale locale)` Provide an instance of IdNumber with Swedish locale and provides implementation of all the method supported.
`Optional<Gender>`	`gender()` Determines the gender of the person that holds this ID number, if applicable.
`static Optional<Gender>`	`gender(IdNumber idNumber)` Extracts the gender from the given person number following the specification for the Swedish idNumber
`boolean`	`isValid()` Checks if the given instance represents a valid Swedish ID number.
`boolean`	`supports(Locale locale)` Defines support method for given locale.
`static boolean`	`valid(IdNumber idNumber)` Standard implementation of validity check for Swedish 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

- Field Detail
  - SE_COUNTRY
```
public static final String SE_COUNTRY
```
    A default country token for Sweden.
    
    See Also:
    
    Constant Field Values
  - SWEDEN
```
public static final Locale SWEDEN
```
    A default Swedish locale.
  - VALID_FORMAT_SE
```
public static final String VALID_FORMAT_SE
```
    A regular expression for checking if a number is in the format of a Swedish ID number.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SwedishIdNumber
```
public SwedishIdNumber(String idToken,
                       Locale locale)
```
    Creates a new Swedish ID with the given locale.
    
    Parameters:
    
    idToken - The ID token to represent.
    
    locale - The Locale for the current instance of SwedishIdNumber
  - SwedishIdNumber
```
public SwedishIdNumber(String idToken)
```
    Creates a Swedish ID with default locale.
    
    Parameters:
    
    idToken - The ID token to represent.
- Method Detail
  - supports
```
public 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.
  - forId
```
public static SwedishIdNumber forId(String token)
```
    Provide an instance of IdNumber with Swedish locale and provides implementation of all the method supported.
    
    Parameters:
    
    token - The idToken
    
    Returns:
    
    An instance of SwedishIdNumber with Locale set to "se", "SE"
  - forId
```
public static SwedishIdNumber forId(String token,
                                    Locale locale)
```
    Provide an instance of IdNumber with Swedish locale and provides implementation of all the method supported.
    
    Parameters:
    
    token - the idToken
    
    locale - The Locale for the current instance of SwedishIdNumber
    
    Returns:
    
    An instance of SwedishIdNumber for the provided locale
  - valid
```
public static boolean valid(IdNumber idNumber)
```
    Standard implementation of validity check for Swedish idNumbers. Implementation is based on Wikipedia specification.
    
    Parameters:
    
    idNumber - The IdNumber to validate
    
    Returns:
    
    True when the token respect the specification given by wikipedia for the Swedish National Id number
  - isValid
```
public boolean isValid()
```
    Checks if the given instance represents a valid Swedish ID number.
    
    Returns:
    
    true if this instance represents a valid Swedish ID number.
  - gender
```
public static Optional<Gender> gender(IdNumber idNumber)
```
    Extracts the gender from the given person number following the specification for the Swedish idNumber
    
    Parameters:
    
    idNumber - The IdNumber to consider
    
    Returns:
    
    The optional gender associated to the given idNumber or empty optional. Optional.empty() in case it is not possible to calculate the Date
  - gender
```
public Optional<Gender> gender()
```
    Determines the gender of the person that holds this ID number, if applicable.
    
    Returns:
    
    The optional gender of the person holding this ID number.
  - birthday
```
public static Optional<LocalDate> birthday(IdNumber idNumber)
```
    Calculates the birth date of the given IdNumber
    
    Parameters:
    
    idNumber - The IdNumber to consider
    
    Returns:
    
    The birth date associated to the given IdNumber
  - birthday
```
public Optional<LocalDate> birthday()
```
    Determines the birth day of the person associated to this ID number, if applicable.
    
    Returns:
    
    The optional birth day of the person holding this ID number.

Class SwedishIdNumber

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

SE_COUNTRY

SWEDEN

VALID_FORMAT_SE

Constructor Detail

SwedishIdNumber

SwedishIdNumber

Method Detail

supports

forId

forId

valid

isValid

gender

gender

birthday

birthday