com.ignaciosandoval.utils.ssn

Class SocialSecurityNumber

java.lang.Object

com.ignaciosandoval.utils.ssn.SocialSecurityNumber

public class SocialSecurityNumber
extends java.lang.Object

Utility class to validate and format a Social Security Number (SSN). The validate method is using the Regular Expresion explained in the article "Validating Social Security Numbers through Regular Expressions" by Rion Williams.

Version:

1.0

Author:

iasandoval

See Also:

Validating Social Security Numbers through Regular Expressions

Constructor Summary

Constructors

Constructor and Description
SocialSecurityNumber(int ssn) Constructor by numeric SSN.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormattedSSN() Get the formatted String representation of the SSN.
java.lang.String	getMaskedSSN() Get the masked representation of the SSN.
int	getRawSSN() Get the numeric representation of the SSN.
java.lang.String	getStringSSN() Get the String representation of the SSN.
boolean	isValid() Validates the provided SSN based in the "Over-The-Top Validation" in the article "Validating Social Security Numbers through Regular Expressions" by Rion Williams.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SocialSecurityNumber

public SocialSecurityNumber(int ssn)

Constructor by numeric SSN.

Parameters:

ssn - The Social Secutiry Number.

Method Detail

isValid

public boolean isValid()

Validates the provided SSN based in the "Over-The-Top Validation" in the article "Validating Social Security Numbers through Regular Expressions" by Rion Williams.

Returns:

True if the SSN provided is valid.

See Also:

Validating Social Security Numbers through Regular Expressions

getRawSSN

public int getRawSSN()

Get the numeric representation of the SSN.

Returns:

The numeric representation of the SSN.

getStringSSN

public java.lang.String getStringSSN()

Get the String representation of the SSN. If the SSN has less than 9 digits, it will fill with leading zeros.

Returns:

The String representation of the SSN.

getFormattedSSN

public java.lang.String getFormattedSSN()

Get the formatted String representation of the SSN.
Format: XXX-XX-XXXX

Returns:

The formatted String representation of the SSN.

getMaskedSSN

public java.lang.String getMaskedSSN()

Get the masked representation of the SSN.
Format: XXX-XX-1234

Returns:

The masked representation of the SSN.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object