com.ignaciosandoval.utils.contact

Class PhoneNumber

java.lang.Object

com.ignaciosandoval.utils.contact.PhoneNumber

All Implemented Interfaces:

ContactMethod

public class PhoneNumber
extends java.lang.Object
implements ContactMethod

Class representing Phone Number as a Contact Method.

Version:

1.0

Author:

iasandoval

Constructor Summary

Constructors

Constructor and Description
PhoneNumber(java.lang.String phoneNumber) Constructor by Phone number.
PhoneNumber(java.lang.String phoneNumber, boolean verified) Constructor by Phone number and Verified value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAreaCode() Getter for the 3 digits Area Code of the Phone Number.
java.lang.String	getFormatted() Returns the Phone Number in format (123) 456-7890.
java.lang.String	getMasked() Returns the Phone Number in masked format (***) ***-7890.
java.lang.String	getType() Getter for the class type.
java.lang.String	getValue() Returns the Phone Number value.
boolean	isEmpty() Indicates if the Phone Number is empty.
boolean	isValid() Match the pattern for a 10 digits Phone Number.
boolean	isVerified() Indicates if the Phone Number is verified.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ignaciosandoval.utils.contact.ContactMethod

isEmpty

Constructor Detail

PhoneNumber

public PhoneNumber(java.lang.String phoneNumber)

Constructor by Phone number.

Will validate if the provided Phone Number is not Empty, if so, it will remove all characters except numbers from it (Cleansing).

Parameters:

phoneNumber - The Phone Number.

PhoneNumber

public PhoneNumber(java.lang.String phoneNumber,
                   boolean verified)

Constructor by Phone number and Verified value.

Will validate if the provided Phone Number is not Empty, if so, it will remove all characters except numbers from it (Cleansing).

Parameters:

phoneNumber - The Phone Number.

verified - Indicates if the Phone Number is Verified.

Method Detail

getFormatted

public java.lang.String getFormatted()

Returns the Phone Number in format (123) 456-7890.

Specified by:

getFormatted in interface ContactMethod

Returns:

The formatted Phone Number.

getMasked

public java.lang.String getMasked()

Returns the Phone Number in masked format (***) ***-7890.

Specified by:

getMasked in interface ContactMethod

Returns:

The masked Phone Number.

getValue

public java.lang.String getValue()

Returns the Phone Number value.

Specified by:

getValue in interface ContactMethod

Returns:

The Phone Number value.

isVerified

public boolean isVerified()

Indicates if the Phone Number is verified.

Specified by:

isVerified in interface ContactMethod

Returns:

True if the Phone NUmber is verified.

isEmpty

public boolean isEmpty()

Indicates if the Phone Number is empty.

Specified by:

isEmpty in interface ContactMethod

Returns:

True if the Phone Number is empty.

isValid

public boolean isValid()

Match the pattern for a 10 digits Phone Number.

Specified by:

isValid in interface ContactMethod

Returns:

True if is a 10 digits Phone Number.

getType

public java.lang.String getType()

Getter for the class type.

Specified by:

getType in interface ContactMethod

Returns:

PhoneNumber (Class Name).

getAreaCode

public java.lang.String getAreaCode()

Getter for the 3 digits Area Code of the Phone Number.

Returns:

3 digits Are Code.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object