ParsedPhoneNumber
public
final
class
ParsedPhoneNumber
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.telephony.ParsedPhoneNumber |
Handles the results from PhoneNumberManager by providing Phone number, error code, and is valid number.
Summary
Constants | |
---|---|
int |
ERROR_TYPE_FAILED_TO_VALIDATE_EXTRACTED_PHONE_NUMER
The phone number failed to be validated. |
int |
ERROR_TYPE_NONE
No error seen. |
int |
ERROR_TYPE_NUMBER_PARSE_EXCEPTION
There was an error when trying to extract the phone number. |
int |
ERROR_TYPE_UNKNOWN
Failed to extract phone number for unknown reason. |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<ParsedPhoneNumber> |
CREATOR
|
Public constructors | |
---|---|
ParsedPhoneNumber(String phoneNumber, int errorCode, boolean isValidPhoneNumber)
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
int
|
getErrorCode()
If no phone number was able to be extracted this will report the failure reason to the user. |
String
|
getParsedPhoneNumber()
Parsed phone number. |
int
|
hashCode()
Returns a hash code value for the object. |
boolean
|
isValidPhoneNumber()
Whether or not we were able to extract a valid phone number |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
ERROR_TYPE_FAILED_TO_VALIDATE_EXTRACTED_PHONE_NUMER
public static final int ERROR_TYPE_FAILED_TO_VALIDATE_EXTRACTED_PHONE_NUMER
The phone number failed to be validated.
Constant Value: 1 (0x00000001)
ERROR_TYPE_NONE
public static final int ERROR_TYPE_NONE
No error seen.
Constant Value: 0 (0x00000000)
ERROR_TYPE_NUMBER_PARSE_EXCEPTION
public static final int ERROR_TYPE_NUMBER_PARSE_EXCEPTION
There was an error when trying to extract the phone number.
Constant Value: 2 (0x00000002)
ERROR_TYPE_UNKNOWN
public static final int ERROR_TYPE_UNKNOWN
Failed to extract phone number for unknown reason.
Constant Value: -1 (0xffffffff)
Fields
Public constructors
ParsedPhoneNumber
public ParsedPhoneNumber (String phoneNumber, int errorCode, boolean isValidPhoneNumber)
Parameters | |
---|---|
phoneNumber |
String : the phone number extracted. Empty if we weren't successful in parsing.
This value cannot be null . |
errorCode |
int : ErrorType seen when trying to extract phone number.
Value is ERROR_TYPE_UNKNOWN , ERROR_TYPE_NONE , ERROR_TYPE_FAILED_TO_VALIDATE_EXTRACTED_PHONE_NUMER , or ERROR_TYPE_NUMBER_PARSE_EXCEPTION |
isValidPhoneNumber |
boolean : whether or not we succeeded in retrieving the number. |
Public methods
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(android.os.Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
equals
public boolean equals (Object o)
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation
on non-null object references:
- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
Parameters | |
---|---|
o |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getErrorCode
public int getErrorCode ()
If no phone number was able to be extracted this will report the failure reason to the user.
Returns | |
---|---|
int |
Value is ERROR_TYPE_UNKNOWN , ERROR_TYPE_NONE , ERROR_TYPE_FAILED_TO_VALIDATE_EXTRACTED_PHONE_NUMER , or ERROR_TYPE_NUMBER_PARSE_EXCEPTION |
getParsedPhoneNumber
public String getParsedPhoneNumber ()
Parsed phone number.
Returns | |
---|---|
String |
This value cannot be null . |
Throws | |
---|---|
IllegalStateException |
if isValidPhoneNumber is false. |
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap
.
The general contract of hashCode
is:
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
equals
method, then calling thehashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns | |
---|---|
int |
a hash code value for this object. |
isValidPhoneNumber
public boolean isValidPhoneNumber ()
Whether or not we were able to extract a valid phone number
Returns | |
---|---|
boolean |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel : This value cannot be null . |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |