From a5afe664c5db66e6331633cb9987af3df4ee485f Mon Sep 17 00:00:00 2001 From: "lararennie@google.com" Date: Thu, 5 May 2011 16:12:07 +0000 Subject: [PATCH] JAVADOC: First run of generating javadoc for the main classes. git-svn-id: http://libphonenumber.googlecode.com/svn/trunk@191 ee073f10-1060-11df-b6a4-87a95322a99c --- javadoc/allclasses-frame.html | 49 + javadoc/allclasses-noframe.html | 49 + .../i18n/phonenumbers/AsYouTypeFormatter.html | 302 +++++ .../NumberParseException.ErrorType.html | 369 +++++ .../i18n/phonenumbers/NumberParseException.html | 311 +++++ .../google/i18n/phonenumbers/PhoneNumberMatch.html | 378 ++++++ .../phonenumbers/PhoneNumberUtil.Leniency.html | 330 +++++ .../phonenumbers/PhoneNumberUtil.MatchType.html | 373 ++++++ .../PhoneNumberUtil.PhoneNumberFormat.html | 365 +++++ .../PhoneNumberUtil.PhoneNumberType.html | 469 +++++++ .../PhoneNumberUtil.ValidationResult.html | 357 +++++ .../google/i18n/phonenumbers/PhoneNumberUtil.html | 1405 ++++++++++++++++++++ .../google/i18n/phonenumbers/package-frame.html | 68 + .../google/i18n/phonenumbers/package-summary.html | 211 +++ .../com/google/i18n/phonenumbers/package-tree.html | 161 +++ javadoc/constant-values.html | 142 ++ javadoc/deprecated-list.html | 142 ++ javadoc/help-doc.html | 209 +++ javadoc/index-all.html | 413 ++++++ javadoc/index.html | 36 + javadoc/overview-tree.html | 163 +++ javadoc/package-list | 1 + javadoc/resources/inherit.gif | Bin 0 -> 57 bytes javadoc/serialized-form.html | 184 +++ javadoc/stylesheet.css | 29 + 25 files changed, 6516 insertions(+) create mode 100644 javadoc/allclasses-frame.html create mode 100644 javadoc/allclasses-noframe.html create mode 100644 javadoc/com/google/i18n/phonenumbers/AsYouTypeFormatter.html create mode 100644 javadoc/com/google/i18n/phonenumbers/NumberParseException.ErrorType.html create mode 100644 javadoc/com/google/i18n/phonenumbers/NumberParseException.html create mode 100644 javadoc/com/google/i18n/phonenumbers/PhoneNumberMatch.html create mode 100644 javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.Leniency.html create mode 100644 javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.MatchType.html create mode 100644 javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.PhoneNumberFormat.html create mode 100644 javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.PhoneNumberType.html create mode 100644 javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.ValidationResult.html create mode 100644 javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.html create mode 100644 javadoc/com/google/i18n/phonenumbers/package-frame.html create mode 100644 javadoc/com/google/i18n/phonenumbers/package-summary.html create mode 100644 javadoc/com/google/i18n/phonenumbers/package-tree.html create mode 100644 javadoc/constant-values.html create mode 100644 javadoc/deprecated-list.html create mode 100644 javadoc/help-doc.html create mode 100644 javadoc/index-all.html create mode 100644 javadoc/index.html create mode 100644 javadoc/overview-tree.html create mode 100644 javadoc/package-list create mode 100644 javadoc/resources/inherit.gif create mode 100644 javadoc/serialized-form.html create mode 100644 javadoc/stylesheet.css diff --git a/javadoc/allclasses-frame.html b/javadoc/allclasses-frame.html new file mode 100644 index 0000000..8fcc099 --- /dev/null +++ b/javadoc/allclasses-frame.html @@ -0,0 +1,49 @@ + + + + + + +All Classes + + + + + + + + + + + +All Classes +
+ + + + + +
AsYouTypeFormatter +
+NumberParseException +
+NumberParseException.ErrorType +
+PhoneNumberMatch +
+PhoneNumberUtil +
+PhoneNumberUtil.Leniency +
+PhoneNumberUtil.MatchType +
+PhoneNumberUtil.PhoneNumberFormat +
+PhoneNumberUtil.PhoneNumberType +
+PhoneNumberUtil.ValidationResult +
+
+ + + diff --git a/javadoc/allclasses-noframe.html b/javadoc/allclasses-noframe.html new file mode 100644 index 0000000..7a9966d --- /dev/null +++ b/javadoc/allclasses-noframe.html @@ -0,0 +1,49 @@ + + + + + + +All Classes + + + + + + + + + + + +All Classes +
+ + + + + +
AsYouTypeFormatter +
+NumberParseException +
+NumberParseException.ErrorType +
+PhoneNumberMatch +
+PhoneNumberUtil +
+PhoneNumberUtil.Leniency +
+PhoneNumberUtil.MatchType +
+PhoneNumberUtil.PhoneNumberFormat +
+PhoneNumberUtil.PhoneNumberType +
+PhoneNumberUtil.ValidationResult +
+
+ + + diff --git a/javadoc/com/google/i18n/phonenumbers/AsYouTypeFormatter.html b/javadoc/com/google/i18n/phonenumbers/AsYouTypeFormatter.html new file mode 100644 index 0000000..3eaef64 --- /dev/null +++ b/javadoc/com/google/i18n/phonenumbers/AsYouTypeFormatter.html @@ -0,0 +1,302 @@ + + + + + + +AsYouTypeFormatter + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.google.i18n.phonenumbers +
+Class AsYouTypeFormatter

+
+java.lang.Object
+  extended by com.google.i18n.phonenumbers.AsYouTypeFormatter
+
+
+
+
public class AsYouTypeFormatter
extends java.lang.Object
+ + +

+A formatter which formats phone numbers as they are entered. + +

An AsYouTypeFormatter can be created by invoking + PhoneNumberUtil#getAsYouTypeFormatter. After that, digits can be added by invoking + inputDigit(char) on the formatter instance, and the partially formatted phone number will be + returned each time a digit is added. clear() can be invoked before formatting a new + number. + +

See the unittests for more details on how the formatter is to be used. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclear() + +
+          Clears the internal state of the formatter, so it can be reused.
+ intgetRememberedPosition() + +
+          Returns the current position in the partially formatted phone number of the character which was + previously passed in as the parameter of inputDigitAndRememberPosition(char).
+ java.lang.StringinputDigit(char nextChar) + +
+          Formats a phone number on-the-fly as each digit is entered.
+ java.lang.StringinputDigitAndRememberPosition(char nextChar) + +
+          Same as inputDigit(char), but remembers the position where nextChar is inserted, so + that it can be retrieved later by using getRememberedPosition().
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+clear

+
+public void clear()
+
+
Clears the internal state of the formatter, so it can be reused. +

+

+
+
+
+
+ +

+inputDigit

+
+public java.lang.String inputDigit(char nextChar)
+
+
Formats a phone number on-the-fly as each digit is entered. +

+

+
Parameters:
nextChar - the most recently entered digit of a phone number. Formatting characters are + allowed, but as soon as they are encountered this method formats the number as entered and + not "as you type" anymore. Full width digits and Arabic-indic digits are allowed, and will + be shown as they are. +
Returns:
the partially formatted phone number.
+
+
+
+ +

+inputDigitAndRememberPosition

+
+public java.lang.String inputDigitAndRememberPosition(char nextChar)
+
+
Same as inputDigit(char), but remembers the position where nextChar is inserted, so + that it can be retrieved later by using getRememberedPosition(). The remembered + position will be automatically adjusted if additional formatting characters are later + inserted/removed in front of nextChar. +

+

+
+
+
+
+ +

+getRememberedPosition

+
+public int getRememberedPosition()
+
+
Returns the current position in the partially formatted phone number of the character which was + previously passed in as the parameter of inputDigitAndRememberPosition(char). +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/com/google/i18n/phonenumbers/NumberParseException.ErrorType.html b/javadoc/com/google/i18n/phonenumbers/NumberParseException.ErrorType.html new file mode 100644 index 0000000..1b1707f --- /dev/null +++ b/javadoc/com/google/i18n/phonenumbers/NumberParseException.ErrorType.html @@ -0,0 +1,369 @@ + + + + + + +NumberParseException.ErrorType + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +com.google.i18n.phonenumbers +
+Enum NumberParseException.ErrorType

+
+java.lang.Object
+  extended by java.lang.Enum<NumberParseException.ErrorType>
+      extended by com.google.i18n.phonenumbers.NumberParseException.ErrorType
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<NumberParseException.ErrorType>
+
+
+
Enclosing class:
NumberParseException
+
+
+
+
public static enum NumberParseException.ErrorType
extends java.lang.Enum<NumberParseException.ErrorType>
+ + +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
INVALID_COUNTRY_CODE + +
+           
NOT_A_NUMBER + +
+           
TOO_LONG + +
+           
TOO_SHORT_AFTER_IDD + +
+           
TOO_SHORT_NSN + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static NumberParseException.ErrorTypevalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static NumberParseException.ErrorType[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+INVALID_COUNTRY_CODE

+
+public static final NumberParseException.ErrorType INVALID_COUNTRY_CODE
+
+
+
+
+
+ +

+NOT_A_NUMBER

+
+public static final NumberParseException.ErrorType NOT_A_NUMBER
+
+
+
+
+
+ +

+TOO_SHORT_AFTER_IDD

+
+public static final NumberParseException.ErrorType TOO_SHORT_AFTER_IDD
+
+
+
+
+
+ +

+TOO_SHORT_NSN

+
+public static final NumberParseException.ErrorType TOO_SHORT_NSN
+
+
+
+
+
+ +

+TOO_LONG

+
+public static final NumberParseException.ErrorType TOO_LONG
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static NumberParseException.ErrorType[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (NumberParseException.ErrorType c : NumberParseException.ErrorType.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static NumberParseException.ErrorType valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/javadoc/com/google/i18n/phonenumbers/NumberParseException.html b/javadoc/com/google/i18n/phonenumbers/NumberParseException.html new file mode 100644 index 0000000..dd9dd43 --- /dev/null +++ b/javadoc/com/google/i18n/phonenumbers/NumberParseException.html @@ -0,0 +1,311 @@ + + + + + + +NumberParseException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.google.i18n.phonenumbers +
+Class NumberParseException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by com.google.i18n.phonenumbers.NumberParseException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class NumberParseException
extends java.lang.Exception
+ + +

+Generic exception class for errors encountered when parsing phone numbers. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classNumberParseException.ErrorType + +
+           
+  + + + + + + + + + + +
+Constructor Summary
NumberParseException(NumberParseException.ErrorType errorType, + java.lang.String message) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ NumberParseException.ErrorTypegetErrorType() + +
+          Returns the error type of the exception that has been thrown.
+ java.lang.StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+NumberParseException

+
+public NumberParseException(NumberParseException.ErrorType errorType,
+                            java.lang.String message)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getErrorType

+
+public NumberParseException.ErrorType getErrorType()
+
+
Returns the error type of the exception that has been thrown. +

+

+
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Throwable
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/com/google/i18n/phonenumbers/PhoneNumberMatch.html b/javadoc/com/google/i18n/phonenumbers/PhoneNumberMatch.html new file mode 100644 index 0000000..4c55eff --- /dev/null +++ b/javadoc/com/google/i18n/phonenumbers/PhoneNumberMatch.html @@ -0,0 +1,378 @@ + + + + + + +PhoneNumberMatch + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.google.i18n.phonenumbers +
+Class PhoneNumberMatch

+
+java.lang.Object
+  extended by com.google.i18n.phonenumbers.PhoneNumberMatch
+
+
+
+
public final class PhoneNumberMatch
extends java.lang.Object
+ + +

+The immutable match of a phone number within a piece of text. Matches may be found using + PhoneNumberUtil#findNumbers. + +

A match consists of the phone number as well as the + start and end offsets of the corresponding subsequence + of the searched text. Use rawString() to obtain a copy of the matched subsequence. + +

The following annotated example clarifies the relationship between the searched text, the + match offsets, and the parsed number: + + 

+ CharSequence text = "Call me at +1 425 882-8080 for details.";
+ RegionCode country = RegionCode.US;
+ PhoneNumberUtil util = PhoneNumberUtil.getInstance();
+
+ // Find the first phone number match:
+ PhoneNumberMatch m = util.findNumbers(text, country).iterator().next();
+
+ // rawString() contains the phone number as it appears in the text.
+ "+1 425 882-8080".equals(m.rawString());
+
+ // start() and end() define the range of the matched subsequence.
+ CharSequence subsequence = text.subSequence(m.start(), m.end());
+ "+1 425 882-8080".contentEquals(subsequence);
+
+ // number() returns the the same result as PhoneNumberUtil.parse()
+ // invoked on rawString().
+ util.parse(m.rawString(), country).equals(m.number());
+
+

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intend() + +
+          Returns the exclusive end index of the matched phone number within the searched text.
+ booleanequals(java.lang.Object obj) + +
+           
+ inthashCode() + +
+           
+ PhoneNumbernumber() + +
+          Returns the phone number matched by the receiver.
+ java.lang.StringrawString() + +
+          Returns the raw string matched as a phone number in the searched text.
+ intstart() + +
+          Returns the start index of the matched phone number within the searched text.
+ java.lang.StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+number

+
+public PhoneNumber number()
+
+
Returns the phone number matched by the receiver. +

+

+
+
+
+
+ +

+start

+
+public int start()
+
+
Returns the start index of the matched phone number within the searched text. +

+

+
+
+
+
+ +

+end

+
+public int end()
+
+
Returns the exclusive end index of the matched phone number within the searched text. +

+

+
+
+
+
+ +

+rawString

+
+public java.lang.String rawString()
+
+
Returns the raw string matched as a phone number in the searched text. +

+

+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class java.lang.Object
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(java.lang.Object obj)
+
+
+
Overrides:
equals in class java.lang.Object
+
+
+
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.Leniency.html b/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.Leniency.html new file mode 100644 index 0000000..08c6631 --- /dev/null +++ b/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.Leniency.html @@ -0,0 +1,330 @@ + + + + + + +PhoneNumberUtil.Leniency + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +com.google.i18n.phonenumbers +
+Enum PhoneNumberUtil.Leniency

+
+java.lang.Object
+  extended by java.lang.Enum<PhoneNumberUtil.Leniency>
+      extended by com.google.i18n.phonenumbers.PhoneNumberUtil.Leniency
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PhoneNumberUtil.Leniency>
+
+
+
Enclosing class:
PhoneNumberUtil
+
+
+
+
public static enum PhoneNumberUtil.Leniency
extends java.lang.Enum<PhoneNumberUtil.Leniency>
+ + +

+Leniency when finding potential phone numbers in text + segments. +

+ +

+

+ +

+ + + + + + + + + + + + + +
+Enum Constant Summary
POSSIBLE + +
+          Phone numbers accepted are possible, but not necessarily valid.
VALID + +
+          Phone numbers accepted are possible and valid.
+  + + + + + + + + + + + + + + + +
+Method Summary
+static PhoneNumberUtil.LeniencyvalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static PhoneNumberUtil.Leniency[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+POSSIBLE

+
+public static final PhoneNumberUtil.Leniency POSSIBLE
+
+
Phone numbers accepted are possible, but not necessarily valid. +

+

+
+
+
+ +

+VALID

+
+public static final PhoneNumberUtil.Leniency VALID
+
+
Phone numbers accepted are possible and valid. +

+

+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static PhoneNumberUtil.Leniency[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (PhoneNumberUtil.Leniency c : PhoneNumberUtil.Leniency.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static PhoneNumberUtil.Leniency valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.MatchType.html b/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.MatchType.html new file mode 100644 index 0000000..250b1a8 --- /dev/null +++ b/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.MatchType.html @@ -0,0 +1,373 @@ + + + + + + +PhoneNumberUtil.MatchType + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +com.google.i18n.phonenumbers +
+Enum PhoneNumberUtil.MatchType

+
+java.lang.Object
+  extended by java.lang.Enum<PhoneNumberUtil.MatchType>
+      extended by com.google.i18n.phonenumbers.PhoneNumberUtil.MatchType
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PhoneNumberUtil.MatchType>
+
+
+
Enclosing class:
PhoneNumberUtil
+
+
+
+
public static enum PhoneNumberUtil.MatchType
extends java.lang.Enum<PhoneNumberUtil.MatchType>
+ + +

+Types of phone number matches. See detailed description beside the isNumberMatch() method. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
EXACT_MATCH + +
+           
NO_MATCH + +
+           
NOT_A_NUMBER + +
+           
NSN_MATCH + +
+           
SHORT_NSN_MATCH + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static PhoneNumberUtil.MatchTypevalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static PhoneNumberUtil.MatchType[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+NOT_A_NUMBER

+
+public static final PhoneNumberUtil.MatchType NOT_A_NUMBER
+
+
+
+
+
+ +

+NO_MATCH

+
+public static final PhoneNumberUtil.MatchType NO_MATCH
+
+
+
+
+
+ +

+SHORT_NSN_MATCH

+
+public static final PhoneNumberUtil.MatchType SHORT_NSN_MATCH
+
+
+
+
+
+ +

+NSN_MATCH

+
+public static final PhoneNumberUtil.MatchType NSN_MATCH
+
+
+
+
+
+ +

+EXACT_MATCH

+
+public static final PhoneNumberUtil.MatchType EXACT_MATCH
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static PhoneNumberUtil.MatchType[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (PhoneNumberUtil.MatchType c : PhoneNumberUtil.MatchType.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static PhoneNumberUtil.MatchType valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.PhoneNumberFormat.html b/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.PhoneNumberFormat.html new file mode 100644 index 0000000..f3c30f8 --- /dev/null +++ b/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.PhoneNumberFormat.html @@ -0,0 +1,365 @@ + + + + + + +PhoneNumberUtil.PhoneNumberFormat + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +com.google.i18n.phonenumbers +
+Enum PhoneNumberUtil.PhoneNumberFormat

+
+java.lang.Object
+  extended by java.lang.Enum<PhoneNumberUtil.PhoneNumberFormat>
+      extended by com.google.i18n.phonenumbers.PhoneNumberUtil.PhoneNumberFormat
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PhoneNumberUtil.PhoneNumberFormat>
+
+
+
Enclosing class:
PhoneNumberUtil
+
+
+
+
public static enum PhoneNumberUtil.PhoneNumberFormat
extends java.lang.Enum<PhoneNumberUtil.PhoneNumberFormat>
+ + +

+INTERNATIONAL and NATIONAL formats are consistent with the definition in ITU-T Recommendation + E. 123. For example, the number of the Google Zurich office will be written as + "+41 44 668 1800" in INTERNATIONAL format, and as "044 668 1800" in NATIONAL format. + E164 format is as per INTERNATIONAL format but with no formatting applied, e.g. +41446681800. + RFC3966 is as per INTERNATIONAL format, but with all spaces and other separating symbols + replaced with a hyphen, and with any phone number extension appended with ";ext=". + + Note: If you are considering storing the number in a neutral format, you are highly advised to + use the PhoneNumber class. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
E164 + +
+           
INTERNATIONAL + +
+           
NATIONAL + +
+           
RFC3966 + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static PhoneNumberUtil.PhoneNumberFormatvalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static PhoneNumberUtil.PhoneNumberFormat[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+E164

+
+public static final PhoneNumberUtil.PhoneNumberFormat E164
+
+
+
+
+
+ +

+INTERNATIONAL

+
+public static final PhoneNumberUtil.PhoneNumberFormat INTERNATIONAL
+
+
+
+
+
+ +

+NATIONAL

+
+public static final PhoneNumberUtil.PhoneNumberFormat NATIONAL
+
+
+
+
+
+ +

+RFC3966

+
+public static final PhoneNumberUtil.PhoneNumberFormat RFC3966
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static PhoneNumberUtil.PhoneNumberFormat[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (PhoneNumberUtil.PhoneNumberFormat c : PhoneNumberUtil.PhoneNumberFormat.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static PhoneNumberUtil.PhoneNumberFormat valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.PhoneNumberType.html b/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.PhoneNumberType.html new file mode 100644 index 0000000..6d2da91 --- /dev/null +++ b/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.PhoneNumberType.html @@ -0,0 +1,469 @@ + + + + + + +PhoneNumberUtil.PhoneNumberType + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +com.google.i18n.phonenumbers +
+Enum PhoneNumberUtil.PhoneNumberType

+
+java.lang.Object
+  extended by java.lang.Enum<PhoneNumberUtil.PhoneNumberType>
+      extended by com.google.i18n.phonenumbers.PhoneNumberUtil.PhoneNumberType
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PhoneNumberUtil.PhoneNumberType>
+
+
+
Enclosing class:
PhoneNumberUtil
+
+
+
+
public static enum PhoneNumberUtil.PhoneNumberType
extends java.lang.Enum<PhoneNumberUtil.PhoneNumberType>
+ + +

+Type of phone numbers. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
FIXED_LINE + +
+           
FIXED_LINE_OR_MOBILE + +
+           
MOBILE + +
+           
PAGER + +
+           
PERSONAL_NUMBER + +
+           
PREMIUM_RATE + +
+           
SHARED_COST + +
+           
TOLL_FREE + +
+           
UAN + +
+           
UNKNOWN + +
+           
VOIP + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static PhoneNumberUtil.PhoneNumberTypevalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static PhoneNumberUtil.PhoneNumberType[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+FIXED_LINE

+
+public static final PhoneNumberUtil.PhoneNumberType FIXED_LINE
+
+
+
+
+
+ +

+MOBILE

+
+public static final PhoneNumberUtil.PhoneNumberType MOBILE
+
+
+
+
+
+ +

+FIXED_LINE_OR_MOBILE

+
+public static final PhoneNumberUtil.PhoneNumberType FIXED_LINE_OR_MOBILE
+
+
+
+
+
+ +

+TOLL_FREE

+
+public static final PhoneNumberUtil.PhoneNumberType TOLL_FREE
+
+
+
+
+
+ +

+PREMIUM_RATE

+
+public static final PhoneNumberUtil.PhoneNumberType PREMIUM_RATE
+
+
+
+
+
+ +

+SHARED_COST

+
+public static final PhoneNumberUtil.PhoneNumberType SHARED_COST
+
+
+
+
+
+ +

+VOIP

+
+public static final PhoneNumberUtil.PhoneNumberType VOIP
+
+
+
+
+
+ +

+PERSONAL_NUMBER

+
+public static final PhoneNumberUtil.PhoneNumberType PERSONAL_NUMBER
+
+
+
+
+
+ +

+PAGER

+
+public static final PhoneNumberUtil.PhoneNumberType PAGER
+
+
+
+
+
+ +

+UAN

+
+public static final PhoneNumberUtil.PhoneNumberType UAN
+
+
+
+
+
+ +

+UNKNOWN

+
+public static final PhoneNumberUtil.PhoneNumberType UNKNOWN
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static PhoneNumberUtil.PhoneNumberType[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (PhoneNumberUtil.PhoneNumberType c : PhoneNumberUtil.PhoneNumberType.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static PhoneNumberUtil.PhoneNumberType valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.ValidationResult.html b/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.ValidationResult.html new file mode 100644 index 0000000..09ac9fb --- /dev/null +++ b/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.ValidationResult.html @@ -0,0 +1,357 @@ + + + + + + +PhoneNumberUtil.ValidationResult + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +com.google.i18n.phonenumbers +
+Enum PhoneNumberUtil.ValidationResult

+
+java.lang.Object
+  extended by java.lang.Enum<PhoneNumberUtil.ValidationResult>
+      extended by com.google.i18n.phonenumbers.PhoneNumberUtil.ValidationResult
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PhoneNumberUtil.ValidationResult>
+
+
+
Enclosing class:
PhoneNumberUtil
+
+
+
+
public static enum PhoneNumberUtil.ValidationResult
extends java.lang.Enum<PhoneNumberUtil.ValidationResult>
+ + +

+Possible outcomes when testing if a PhoneNumber is possible. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
INVALID_COUNTRY_CODE + +
+           
IS_POSSIBLE + +
+           
TOO_LONG + +
+           
TOO_SHORT + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static PhoneNumberUtil.ValidationResultvalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static PhoneNumberUtil.ValidationResult[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+IS_POSSIBLE

+
+public static final PhoneNumberUtil.ValidationResult IS_POSSIBLE
+
+
+
+
+
+ +

+INVALID_COUNTRY_CODE

+
+public static final PhoneNumberUtil.ValidationResult INVALID_COUNTRY_CODE
+
+
+
+
+
+ +

+TOO_SHORT

+
+public static final PhoneNumberUtil.ValidationResult TOO_SHORT
+
+
+
+
+
+ +

+TOO_LONG

+
+public static final PhoneNumberUtil.ValidationResult TOO_LONG
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static PhoneNumberUtil.ValidationResult[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (PhoneNumberUtil.ValidationResult c : PhoneNumberUtil.ValidationResult.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static PhoneNumberUtil.ValidationResult valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.html b/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.html new file mode 100644 index 0000000..8268b10 --- /dev/null +++ b/javadoc/com/google/i18n/phonenumbers/PhoneNumberUtil.html @@ -0,0 +1,1405 @@ + + + + + + +PhoneNumberUtil + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +com.google.i18n.phonenumbers +
+Class PhoneNumberUtil

+
+java.lang.Object
+  extended by com.google.i18n.phonenumbers.PhoneNumberUtil
+
+
+
+
public class PhoneNumberUtil
extends java.lang.Object
+ + +

+Utility for international phone numbers. Functionality includes formatting, parsing and + validation. + +

If you use this library, and want to be notified about important changes, please sign up to + our mailing list. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Nested Class Summary
+static classPhoneNumberUtil.Leniency + +
+          Leniency when finding potential phone numbers in text + segments.
+static classPhoneNumberUtil.MatchType + +
+          Types of phone number matches.
+static classPhoneNumberUtil.PhoneNumberFormat + +
+          INTERNATIONAL and NATIONAL formats are consistent with the definition in ITU-T Recommendation + E.
+static classPhoneNumberUtil.PhoneNumberType + +
+          Type of phone numbers.
+static classPhoneNumberUtil.ValidationResult + +
+          Possible outcomes when testing if a PhoneNumber is possible.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static java.lang.StringconvertAlphaCharactersInNumber(java.lang.String number) + +
+          Converts all alpha characters in a number to their respective digits on a keypad, but retains + existing formatting.
+ java.lang.Iterable<PhoneNumberMatch>findNumbers(java.lang.CharSequence text, + java.lang.String defaultRegion) + +
+          Returns an iterable over all PhoneNumberMatches in text.
+ java.lang.Iterable<PhoneNumberMatch>findNumbers(java.lang.CharSequence text, + java.lang.String defaultRegion, + PhoneNumberUtil.Leniency leniency, + long maxTries) + +
+          Returns an iterable over all PhoneNumberMatches in text.
+ java.lang.Stringformat(PhoneNumber number, + PhoneNumberUtil.PhoneNumberFormat numberFormat) + +
+          Formats a phone number in the specified format using default rules.
+ voidformat(PhoneNumber number, + PhoneNumberUtil.PhoneNumberFormat numberFormat, + java.lang.StringBuilder formattedNumber) + +
+           
+ java.lang.StringformatByPattern(PhoneNumber number, + PhoneNumberUtil.PhoneNumberFormat numberFormat, + java.util.List<NumberFormat> userDefinedFormats) + +
+          Formats a phone number in the specified format using client-defined formatting rules.
+ java.lang.StringformatInOriginalFormat(PhoneNumber number, + java.lang.String regionCallingFrom) + +
+          Formats a phone number using the original phone number format that the number is parsed from.
+ java.lang.StringformatNationalNumberWithCarrierCode(PhoneNumber number, + java.lang.String carrierCode) + +
+          Formats a phone number in national format for dialing using the carrier as specified in the + carrierCode.
+ java.lang.StringformatNationalNumberWithPreferredCarrierCode(PhoneNumber number, + java.lang.String fallbackCarrierCode) + +
+          Formats a phone number in national format for dialing using the carrier as specified in the + preferredDomesticCarrierCode field of the PhoneNumber object passed in.
+ java.lang.StringformatOutOfCountryCallingNumber(PhoneNumber number, + java.lang.String regionCallingFrom) + +
+          Formats a phone number for out-of-country dialing purposes.
+ java.lang.StringformatOutOfCountryKeepingAlphaChars(PhoneNumber number, + java.lang.String regionCallingFrom) + +
+          Formats a phone number for out-of-country dialing purposes.
+ AsYouTypeFormattergetAsYouTypeFormatter(java.lang.String regionCode) + +
+          Gets an AsYouTypeFormatter for the specific region.
+ intgetCountryCodeForRegion(java.lang.String regionCode) + +
+          Returns the country calling code for a specific region.
+ PhoneNumbergetExampleNumber(java.lang.String regionCode) + +
+          Gets a valid number for the specified region.
+ PhoneNumbergetExampleNumberForType(java.lang.String regionCode, + PhoneNumberUtil.PhoneNumberType type) + +
+          Gets a valid number for the specified region and number type.
+static PhoneNumberUtilgetInstance() + +
+          Gets a PhoneNumberUtil instance to carry out international phone number formatting, + parsing, or validation.
+ intgetLengthOfGeographicalAreaCode(PhoneNumber number) + +
+          Gets the length of the geographical area code in the nationalNumber_ field of the + PhoneNumber object passed in, so that clients could use it to split a national significant + number into geographical area code and subscriber number.
+ intgetLengthOfNationalDestinationCode(PhoneNumber number) + +
+          Gets the length of the national destination code (NDC) from the PhoneNumber object passed in, + so that clients could use it to split a national significant number into NDC and subscriber + number.
+ java.lang.StringgetNationalSignificantNumber(PhoneNumber number) + +
+          Gets the national significant number of the a phone number.
+ java.lang.StringgetNddPrefixForRegion(java.lang.String regionCode, + boolean stripNonDigits) + +
+          Returns the national dialling prefix for a specific region.
+ PhoneNumberUtil.PhoneNumberTypegetNumberType(PhoneNumber number) + +
+          Gets the type of a phone number.
+ java.lang.StringgetRegionCodeForCountryCode(int countryCallingCode) + +
+          Returns the region code that matches the specific country calling code.
+ java.lang.StringgetRegionCodeForNumber(PhoneNumber number) + +
+          Returns the region where a phone number is from.
+ java.util.Set<java.lang.String>getSupportedRegions() + +
+          Convenience method to enable tests to get a list of what regions the library has metadata for.
+ booleanisAlphaNumber(java.lang.String number) + +
+          Checks if the number is a valid vanity (alpha) number such as 800 MICROSOFT.
+ booleanisNANPACountry(java.lang.String regionCode) + +
+          Checks if this is a region under the North American Numbering Plan Administration (NANPA).
+ PhoneNumberUtil.MatchTypeisNumberMatch(PhoneNumber firstNumberIn, + PhoneNumber secondNumberIn) + +
+          Takes two phone numbers and compares them for equality.
+ PhoneNumberUtil.MatchTypeisNumberMatch(PhoneNumber firstNumber, + java.lang.String secondNumber) + +
+          Takes two phone numbers and compares them for equality.
+ booleanisPossibleNumber(PhoneNumber number) + +
+          Convenience wrapper around isPossibleNumberWithReason(PhoneNumber).
+ booleanisPossibleNumber(java.lang.String number, + java.lang.String regionDialingFrom) + +
+          Check whether a phone number is a possible number given a number in the form of a string, and + the region where the number could be dialed from.
+ PhoneNumberUtil.ValidationResultisPossibleNumberWithReason(PhoneNumber number) + +
+          Check whether a phone number is a possible number.
+ booleanisValidNumber(PhoneNumber number) + +
+          Tests whether a phone number matches a valid pattern.
+ booleanisValidNumberForRegion(PhoneNumber number, + java.lang.String regionCode) + +
+          Tests whether a phone number is valid for a certain region.
+static java.lang.StringnormalizeDigitsOnly(java.lang.String number) + +
+          Normalizes a string of characters representing a phone number.
+ PhoneNumberparse(java.lang.String numberToParse, + java.lang.String defaultRegion) + +
+          Parses a string and returns it in proto buffer format.
+ voidparse(java.lang.String numberToParse, + java.lang.String defaultRegion, + PhoneNumber phoneNumber) + +
+           
+ PhoneNumberparseAndKeepRawInput(java.lang.String numberToParse, + java.lang.String defaultRegion) + +
+          Parses a string and returns it in proto buffer format.
+ voidparseAndKeepRawInput(java.lang.String numberToParse, + java.lang.String defaultRegion, + PhoneNumber phoneNumber) + +
+           
+ booleantruncateTooLongNumber(PhoneNumber number) + +
+          Attempts to extract a valid number from a phone number that is too long to be valid, and resets + the PhoneNumber object passed in to that valid version.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+normalizeDigitsOnly

+
+public static java.lang.String normalizeDigitsOnly(java.lang.String number)
+
+
Normalizes a string of characters representing a phone number. This converts wide-ascii and + arabic-indic numerals to European numerals, and strips punctuation and alpha characters. +

+

+
Parameters:
number - a string of characters representing a phone number +
Returns:
the normalized string version of the phone number
+
+
+
+ +

+convertAlphaCharactersInNumber

+
+public static java.lang.String convertAlphaCharactersInNumber(java.lang.String number)
+
+
Converts all alpha characters in a number to their respective digits on a keypad, but retains + existing formatting. This Java implementation of this function also converts wide-ascii digits + to normal ascii digits, and converts Arabic-Indic numerals to European numerals. +

+

+
+
+
+
+ +

+getLengthOfGeographicalAreaCode

+
+public int getLengthOfGeographicalAreaCode(PhoneNumber number)
+
+
Gets the length of the geographical area code in the nationalNumber_ field of the + PhoneNumber object passed in, so that clients could use it to split a national significant + number into geographical area code and subscriber number. It works in such a way that the + resultant subscriber number should be diallable, at least on some devices. An example of how + this could be used: + + 
+ PhoneNumberUtil phoneUtil = PhoneNumberUtil.getInstance();
+ PhoneNumber number = phoneUtil.parse("16502530000", "US");
+ String nationalSignificantNumber = phoneUtil.getNationalSignificantNumber(number);
+ String areaCode;
+ String subscriberNumber;
+
+ int areaCodeLength = phoneUtil.getLengthOfGeographicalAreaCode(number);
+ if (areaCodeLength > 0) {
+   areaCode = nationalSignificantNumber.substring(0, areaCodeLength);
+   subscriberNumber = nationalSignificantNumber.substring(areaCodeLength);
+ } else {
+   areaCode = "";
+   subscriberNumber = nationalSignificantNumber;
+ }
+
+ + N.B.: area code is a very ambiguous concept, so the I18N team generally recommends against + using it for most purposes. Read the following carefully before deciding to use this method: + + - geographical area codes change over time, and this method honors those changes; therefore, + it doesn't guarantee the stability of the result it produces. + - subscriber numbers may not be diallable from all devices (notably mobile devices, which + typically requires the full national_number to be dialled in most countries). + - most non-geographical numbers have no area codes. + - some geographical numbers have no area codes. +

+

+
Parameters:
number - the PhoneNumber object for which clients want to know the length of the area + code. +
Returns:
the length of area code of the PhoneNumber object passed in.
+
+
+
+ +

+getLengthOfNationalDestinationCode

+
+public int getLengthOfNationalDestinationCode(PhoneNumber number)
+
+
Gets the length of the national destination code (NDC) from the PhoneNumber object passed in, + so that clients could use it to split a national significant number into NDC and subscriber + number. The NDC of a phone number is normally the first group of digit(s) right after the + country calling code when the number is formatted in the international format, if there is a + subscriber number part that follows. An example of how this could be used: + + PhoneNumberUtil phoneUtil = PhoneNumberUtil.getInstance(); + PhoneNumber number = phoneUtil.parse("18002530000", "US"); + String nationalSignificantNumber = phoneUtil.getNationalSignificantNumber(number); + String nationalDestinationCode; + String subscriberNumber; + + int nationalDestinationCodeLength = phoneUtil.getLengthOfNationalDestinationCode(number); + if (nationalDestinationCodeLength > 0) { + nationalDestinationCode = nationalSignificantNumber.substring(0, + nationalDestinationCodeLength); + subscriberNumber = nationalSignificantNumber.substring(nationalDestinationCodeLength); + } else { + nationalDestinationCode = ""; + subscriberNumber = nationalSignificantNumber; + } + + + Refer to the unittests to see the difference between this function and + getLengthOfGeographicalAreaCode(). +

+

+
Parameters:
number - the PhoneNumber object for which clients want to know the length of the NDC. +
Returns:
the length of NDC of the PhoneNumber object passed in.
+
+
+
+ +

+getSupportedRegions

+
+public java.util.Set<java.lang.String> getSupportedRegions()
+
+
Convenience method to enable tests to get a list of what regions the library has metadata for. +

+

+
+
+
+
+ +

+getInstance

+
+public static PhoneNumberUtil getInstance()
+
+
Gets a PhoneNumberUtil instance to carry out international phone number formatting, + parsing, or validation. The instance is loaded with phone number metadata for a number of most + commonly used regions. + +

The PhoneNumberUtil is implemented as a singleton. Therefore, calling getInstance + multiple times will only result in one instance being created. +

+

+ +
Returns:
a PhoneNumberUtil instance
+
+
+
+ +

+format

+
+public java.lang.String format(PhoneNumber number,
+                               PhoneNumberUtil.PhoneNumberFormat numberFormat)
+
+
Formats a phone number in the specified format using default rules. Note that this does not + promise to produce a phone number that the user can dial from where they are - although we do + format in either 'national' or 'international' format depending on what the client asks for, we + do not currently support a more abbreviated format, such as for users in the same "area" who + could potentially dial the number without area code. Note that if the phone number has a + country calling code of 0 or an otherwise invalid country calling code, we cannot work out + which formatting rules to apply so we return the national significant number with no formatting + applied. +

+

+
Parameters:
number - the phone number to be formatted
numberFormat - the format the phone number should be formatted into +
Returns:
the formatted phone number
+
+
+
+ +

+format

+
+public void format(PhoneNumber number,
+                   PhoneNumberUtil.PhoneNumberFormat numberFormat,
+                   java.lang.StringBuilder formattedNumber)
+
+
+
+
+
+
+ +

+formatByPattern

+
+public java.lang.String formatByPattern(PhoneNumber number,
+                                        PhoneNumberUtil.PhoneNumberFormat numberFormat,
+                                        java.util.List<NumberFormat> userDefinedFormats)
+
+
Formats a phone number in the specified format using client-defined formatting rules. Note that + if the phone number has a country calling code of zero or an otherwise invalid country calling + code, we cannot work out things like whether there should be a national prefix applied, or how + to format extensions, so we return the national significant number with no formatting applied. +

+

+
Parameters:
number - the phone number to be formatted
numberFormat - the format the phone number should be formatted into
userDefinedFormats - formatting rules specified by clients +
Returns:
the formatted phone number
+
+
+
+ +

+formatNationalNumberWithCarrierCode

+
+public java.lang.String formatNationalNumberWithCarrierCode(PhoneNumber number,
+                                                            java.lang.String carrierCode)
+
+
Formats a phone number in national format for dialing using the carrier as specified in the + carrierCode. The carrierCode will always be used regardless of whether the + phone number already has a preferred domestic carrier code stored. If carrierCode + contains an empty string, returns the number in national format without any carrier code. +

+

+
Parameters:
number - the phone number to be formatted
carrierCode - the carrier selection code to be used +
Returns:
the formatted phone number in national format for dialing using the carrier as + specified in the carrierCode
+
+
+
+ +

+formatNationalNumberWithPreferredCarrierCode

+
+public java.lang.String formatNationalNumberWithPreferredCarrierCode(PhoneNumber number,
+                                                                     java.lang.String fallbackCarrierCode)
+
+
Formats a phone number in national format for dialing using the carrier as specified in the + preferredDomesticCarrierCode field of the PhoneNumber object passed in. If that is missing, + use the fallbackCarrierCode passed in instead. If there is no + preferredDomesticCarrierCode, and the fallbackCarrierCode contains an empty + string, return the number in national format without any carrier code. + +

Use formatNationalNumberWithCarrierCode(PhoneNumber, java.lang.String) instead if the carrier code passed in + should take precedence over the number's preferredDomesticCarrierCode when formatting. +

+

+
Parameters:
number - the phone number to be formatted
fallbackCarrierCode - the carrier selection code to be used, if none is found in the + phone number itself +
Returns:
the formatted phone number in national format for dialing using the number's + preferredDomesticCarrierCode, or the fallbackCarrierCode passed in if + none is found
+
+
+
+ +

+formatOutOfCountryCallingNumber

+
+public java.lang.String formatOutOfCountryCallingNumber(PhoneNumber number,
+                                                        java.lang.String regionCallingFrom)
+
+
Formats a phone number for out-of-country dialing purposes. If no regionCallingFrom is + supplied, we format the number in its INTERNATIONAL format. If the country calling code is the + same as the region where the number is from, then NATIONAL formatting will be applied. + +

If the number itself has a country calling code of zero or an otherwise invalid country + calling code, then we return the number with no formatting applied. + +

Note this function takes care of the case for calling inside of NANPA and between Russia and + Kazakhstan (who share the same country calling code). In those cases, no international prefix + is used. For regions which have multiple international prefixes, the number in its + INTERNATIONAL format will be returned instead. +

+

+
Parameters:
number - the phone number to be formatted
regionCallingFrom - the ISO 3166-1 two-letter region code that denotes the region + where the call is being placed +
Returns:
the formatted phone number
+
+
+
+ +

+formatInOriginalFormat

+
+public java.lang.String formatInOriginalFormat(PhoneNumber number,
+                                               java.lang.String regionCallingFrom)
+
+
Formats a phone number using the original phone number format that the number is parsed from. + The original format is embedded in the country_code_source field of the PhoneNumber object + passed in. If such information is missing, the number will be formatted into the NATIONAL + format by default. +

+

+
Parameters:
number - the phone number that needs to be formatted in its original number format
regionCallingFrom - the region whose IDD needs to be prefixed if the original number + has one +
Returns:
the formatted phone number in its original number format
+
+
+
+ +

+formatOutOfCountryKeepingAlphaChars

+
+public java.lang.String formatOutOfCountryKeepingAlphaChars(PhoneNumber number,
+                                                            java.lang.String regionCallingFrom)
+
+
Formats a phone number for out-of-country dialing purposes. + + Note that in this version, if the number was entered originally using alpha characters and + this version of the number is stored in raw_input, this representation of the number will be + used rather than the digit representation. Grouping information, as specified by characters + such as "-" and " ", will be retained. + +

Caveats:

+
    +
  • This will not produce good results if the country calling code is both present in the raw + input _and_ is the start of the national number. This is not a problem in the regions + which typically use alpha numbers. +
  • This will also not produce good results if the raw input has any grouping information + within the first three digits of the national number, and if the function needs to strip + preceding digits/words in the raw input before these digits. Normally people group the + first three digits together so this is not a huge problem - and will be fixed if it + proves to be so. +
+

+

+
Parameters:
number - the phone number that needs to be formatted
regionCallingFrom - the region where the call is being placed +
Returns:
the formatted phone number
+
+
+
+ +

+getNationalSignificantNumber

+
+public java.lang.String getNationalSignificantNumber(PhoneNumber number)
+
+
Gets the national significant number of the a phone number. Note a national significant number + doesn't contain a national prefix or any formatting. +

+

+
Parameters:
number - the PhoneNumber object for which the national significant number is needed +
Returns:
the national significant number of the PhoneNumber object passed in
+
+
+
+ +

+getExampleNumber

+
+public PhoneNumber getExampleNumber(java.lang.String regionCode)
+
+
Gets a valid number for the specified region. +

+

+
Parameters:
regionCode - the ISO 3166-1 two-letter region code that denotes + the region for which an example number is needed +
Returns:
a valid fixed-line number for the specified region. Returns null when the metadata + does not contain such information.
+
+
+
+ +

+getExampleNumberForType

+
+public PhoneNumber getExampleNumberForType(java.lang.String regionCode,
+                                           PhoneNumberUtil.PhoneNumberType type)
+
+
Gets a valid number for the specified region and number type. +

+

+
Parameters:
regionCode - the ISO 3166-1 two-letter region code that denotes + the region for which an example number is needed
type - the type of number that is needed +
Returns:
a valid number for the specified region and type. Returns null when the metadata + does not contain such information.
+
+
+
+ +

+getNumberType

+
+public PhoneNumberUtil.PhoneNumberType getNumberType(PhoneNumber number)
+
+
Gets the type of a phone number. +

+

+
Parameters:
number - the phone number that we want to know the type +
Returns:
the type of the phone number
+
+
+
+ +

+isValidNumber

+
+public boolean isValidNumber(PhoneNumber number)
+
+
Tests whether a phone number matches a valid pattern. Note this doesn't verify the number + is actually in use, which is impossible to tell by just looking at a number itself. +

+

+
Parameters:
number - the phone number that we want to validate +
Returns:
a boolean that indicates whether the number is of a valid pattern
+
+
+
+ +

+isValidNumberForRegion

+
+public boolean isValidNumberForRegion(PhoneNumber number,
+                                      java.lang.String regionCode)
+
+
Tests whether a phone number is valid for a certain region. Note this doesn't verify the number + is actually in use, which is impossible to tell by just looking at a number itself. If the + country calling code is not the same as the country calling code for the region, this + immediately exits with false. After this, the specific number pattern rules for the region are + examined. This is useful for determining for example whether a particular number is valid for + Canada, rather than just a valid NANPA number. +

+

+
Parameters:
number - the phone number that we want to validate
regionCode - the ISO 3166-1 two-letter region code that denotes the region that we want + to validate the phone number for +
Returns:
a boolean that indicates whether the number is of a valid pattern
+
+
+
+ +

+getRegionCodeForNumber

+
+public java.lang.String getRegionCodeForNumber(PhoneNumber number)
+
+
Returns the region where a phone number is from. This could be used for geocoding at the region + level. +

+

+
Parameters:
number - the phone number whose origin we want to know +
Returns:
the region where the phone number is from, or null if no region matches this calling + code
+
+
+
+ +

+getRegionCodeForCountryCode

+
+public java.lang.String getRegionCodeForCountryCode(int countryCallingCode)
+
+
Returns the region code that matches the specific country calling code. In the case of no + region code being found, ZZ will be returned. In the case of multiple regions, the one + designated in the metadata as the "main" region for this calling code will be returned. +

+

+
+
+
+
+ +

+getCountryCodeForRegion

+
+public int getCountryCodeForRegion(java.lang.String regionCode)
+
+
Returns the country calling code for a specific region. For example, this would be 1 for the + United States, and 64 for New Zealand. +

+

+
Parameters:
regionCode - the ISO 3166-1 two-letter region code that denotes + the region that we want to get the country calling code for +
Returns:
the country calling code for the region denoted by regionCode
+
+
+
+ +

+getNddPrefixForRegion

+
+public java.lang.String getNddPrefixForRegion(java.lang.String regionCode,
+                                              boolean stripNonDigits)
+
+
Returns the national dialling prefix for a specific region. For example, this would be 1 for + the United States, and 0 for New Zealand. Set stripNonDigits to true to strip symbols like "~" + (which indicates a wait for a dialling tone) from the prefix returned. If no national prefix is + present, we return null. + +

Warning: Do not use this method for do-your-own formatting - for some regions, the + national dialling prefix is used only for certain types of numbers. Use the library's + formatting functions to prefix the national prefix when required. +

+

+
Parameters:
regionCode - the ISO 3166-1 two-letter region code that denotes + the region that we want to get the dialling prefix for
stripNonDigits - true to strip non-digits from the national dialling prefix +
Returns:
the dialling prefix for the region denoted by regionCode
+
+
+
+ +

+isNANPACountry

+
+public boolean isNANPACountry(java.lang.String regionCode)
+
+
Checks if this is a region under the North American Numbering Plan Administration (NANPA). +

+

+ +
Returns:
true if regionCode is one of the regions under NANPA
+
+
+
+ +

+isAlphaNumber

+
+public boolean isAlphaNumber(java.lang.String number)
+
+
Checks if the number is a valid vanity (alpha) number such as 800 MICROSOFT. A valid vanity + number will start with at least 3 digits and will have three or more alpha characters. This + does not do region-specific checks - to work out if this number is actually valid for a region, + it should be parsed and methods such as isPossibleNumberWithReason(PhoneNumber) and + isValidNumber(PhoneNumber) should be used. +

+

+
Parameters:
number - the number that needs to be checked +
Returns:
true if the number is a valid vanity number
+
+
+
+ +

+isPossibleNumber

+
+public boolean isPossibleNumber(PhoneNumber number)
+
+
Convenience wrapper around isPossibleNumberWithReason(PhoneNumber). Instead of returning the reason + for failure, this method returns a boolean value. +

+

+
Parameters:
number - the number that needs to be checked +
Returns:
true if the number is possible
+
+
+
+ +

+isPossibleNumberWithReason

+
+public PhoneNumberUtil.ValidationResult isPossibleNumberWithReason(PhoneNumber number)
+
+
Check whether a phone number is a possible number. It provides a more lenient check than + isValidNumber(PhoneNumber) in the following sense: +
    +
  1. It only checks the length of phone numbers. In particular, it doesn't check starting + digits of the number. +
  2. It doesn't attempt to figure out the type of the number, but uses general rules which + applies to all types of phone numbers in a region. Therefore, it is much faster than + isValidNumber. +
  3. For fixed line numbers, many regions have the concept of area code, which together with + subscriber number constitute the national significant number. It is sometimes okay to dial + the subscriber number only when dialing in the same area. This function will return + true if the subscriber-number-only version is passed in. On the other hand, because + isValidNumber validates using information on both starting digits (for fixed line + numbers, that would most likely be area codes) and length (obviously includes the + length of area codes for fixed line numbers), it will return false for the + subscriber-number-only version. +
+
+
Parameters:
number - the number that needs to be checked +
Returns:
a ValidationResult object which indicates whether the number is possible
+
+
+
+ +

+isPossibleNumber

+
+public boolean isPossibleNumber(java.lang.String number,
+                                java.lang.String regionDialingFrom)
+
+
Check whether a phone number is a possible number given a number in the form of a string, and + the region where the number could be dialed from. It provides a more lenient check than + isValidNumber(PhoneNumber). See isPossibleNumber(PhoneNumber) for details. + +

This method first parses the number, then invokes isPossibleNumber(PhoneNumber + number) with the resultant PhoneNumber object. +

+

+
Parameters:
number - the number that needs to be checked, in the form of a string
regionDialingFrom - the ISO 3166-1 two-letter region code that denotes the region that + we are expecting the number to be dialed from. + Note this is different from the region where the number belongs. For example, the number + +1 650 253 0000 is a number that belongs to US. When written in this form, it can be + dialed from any region. When it is written as 00 1 650 253 0000, it can be dialed from any + region which uses an international dialling prefix of 00. When it is written as + 650 253 0000, it can only be dialed from within the US, and when written as 253 0000, it + can only be dialed from within a smaller area in the US (Mountain View, CA, to be more + specific). +
Returns:
true if the number is possible
+
+
+
+ +

+truncateTooLongNumber

+
+public boolean truncateTooLongNumber(PhoneNumber number)
+
+
Attempts to extract a valid number from a phone number that is too long to be valid, and resets + the PhoneNumber object passed in to that valid version. If no valid number could be extracted, + the PhoneNumber object passed in will not be modified. +

+

+
Parameters:
number - a PhoneNumber object which contains a number that is too long to be valid. +
Returns:
true if a valid phone number can be successfully extracted.
+
+
+
+ +

+getAsYouTypeFormatter

+
+public AsYouTypeFormatter getAsYouTypeFormatter(java.lang.String regionCode)
+
+
Gets an AsYouTypeFormatter for the specific region. +

+

+
Parameters:
regionCode - the ISO 3166-1 two-letter region code that denotes the region where + the phone number is being entered +
Returns:
an AsYouTypeFormatter object, which can be used + to format phone numbers in the specific region "as you type"
+
+
+
+ +

+parse

+
+public PhoneNumber parse(java.lang.String numberToParse,
+                         java.lang.String defaultRegion)
+                  throws NumberParseException
+
+
Parses a string and returns it in proto buffer format. This method will throw a + NumberParseException if the number is not considered to be + a possible number. Note that validation of whether the number is actually a valid number for a + particular region is not performed. This can be done separately with isValidNumber(PhoneNumber). +

+

+
Parameters:
numberToParse - number that we are attempting to parse. This can contain formatting + such as +, ( and -, as well as a phone number extension.
defaultRegion - the ISO 3166-1 two-letter region code that denotes the region that we + are expecting the number to be from. This is only used if the number + being parsed is not written in international format. + The country_code for the number in this case would be stored as that + of the default region supplied. If the number is guaranteed to + start with a '+' followed by the country calling code, then "ZZ" or + null can be supplied. +
Returns:
a phone number proto buffer filled with the parsed number +
Throws: +
NumberParseException - if the string is not considered to be a viable phone number or if + no default region was supplied and the number is not in + international format (does not start with +)
+
+
+
+ +

+parse

+
+public void parse(java.lang.String numberToParse,
+                  java.lang.String defaultRegion,
+                  PhoneNumber phoneNumber)
+           throws NumberParseException
+
+
+ +
Throws: +
NumberParseException
+
+
+
+ +

+parseAndKeepRawInput

+
+public PhoneNumber parseAndKeepRawInput(java.lang.String numberToParse,
+                                        java.lang.String defaultRegion)
+                                 throws NumberParseException
+
+
Parses a string and returns it in proto buffer format. This method differs from parse(java.lang.String, java.lang.String) + in that it always populates the raw_input field of the protocol buffer with numberToParse as + well as the country_code_source field. +

+

+
Parameters:
numberToParse - number that we are attempting to parse. This can contain formatting + such as +, ( and -, as well as a phone number extension.
defaultRegion - the ISO 3166-1 two-letter region code that denotes the region that + we are expecting the number to be from. This is only used if the + number being parsed is not written in international format. The + country calling code for the number in this case would be stored as + that of the default region supplied. +
Returns:
a phone number proto buffer filled with the parsed number +
Throws: +
NumberParseException - if the string is not considered to be a viable phone number or if + no default region was supplied
+
+
+
+ +

+parseAndKeepRawInput

+
+public void parseAndKeepRawInput(java.lang.String numberToParse,
+                                 java.lang.String defaultRegion,
+                                 PhoneNumber phoneNumber)
+                          throws NumberParseException
+
+
+ +
Throws: +
NumberParseException
+
+
+
+ +

+findNumbers

+
+public java.lang.Iterable<PhoneNumberMatch> findNumbers(java.lang.CharSequence text,
+                                                        java.lang.String defaultRegion)
+
+
Returns an iterable over all PhoneNumberMatches in text. This + is a shortcut for getMatcher(text, defaultRegion, Leniency.VALID, Long.MAX_VALUE). +

+

+
Parameters:
text - the text to search for phone numbers, null for no text
defaultRegion - the ISO 3166-1 two-letter region code that denotes the region that + we are expecting the number to be from. This is only used if the + number being parsed is not written in international format. The + country calling code for the number in this case would be stored as + that of the default region supplied. May be null if only international + numbers are expected.
+
+
+
+ +

+findNumbers

+
+public java.lang.Iterable<PhoneNumberMatch> findNumbers(java.lang.CharSequence text,
+                                                        java.lang.String defaultRegion,
+                                                        PhoneNumberUtil.Leniency leniency,
+                                                        long maxTries)
+
+
Returns an iterable over all PhoneNumberMatches in text. +

+

+
Parameters:
text - the text to search for phone numbers, null for no text
defaultRegion - the ISO 3166-1 two-letter region code that denotes the region that + we are expecting the number to be from. This is only used if the + number being parsed is not written in international format. The + country calling code for the number in this case would be stored as + that of the default region supplied. May be null if only international + numbers are expected.
leniency - the leniency to use when evaluating candidate phone numbers
maxTries - the maximum number of invalid numbers to try before giving up on the + text. This is to cover degenerate cases where the text has a lot of + false positives in it. Must be >= 0.
+
+
+
+ +

+isNumberMatch

+
+public PhoneNumberUtil.MatchType isNumberMatch(PhoneNumber firstNumberIn,
+                                               PhoneNumber secondNumberIn)
+
+
Takes two phone numbers and compares them for equality. + +

Returns EXACT_MATCH if the country_code, NSN, presence of a leading zero for Italian numbers + and any extension present are the same. + Returns NSN_MATCH if either or both has no region specified, and the NSNs and extensions are + the same. + Returns SHORT_NSN_MATCH if either or both has no region specified, or the region specified is + the same, and one NSN could be a shorter version of the other number. This includes the case + where one has an extension specified, and the other does not. + Returns NO_MATCH otherwise. + For example, the numbers +1 345 657 1234 and 657 1234 are a SHORT_NSN_MATCH. + The numbers +1 345 657 1234 and 345 657 are a NO_MATCH. +

+

+
Parameters:
firstNumberIn - first number to compare
secondNumberIn - second number to compare +
Returns:
NO_MATCH, SHORT_NSN_MATCH, NSN_MATCH or EXACT_MATCH depending on the level of equality + of the two numbers, described in the method definition.
+
+
+
+ +

+isNumberMatch

+
+public PhoneNumberUtil.MatchType isNumberMatch(PhoneNumber firstNumber,
+                                               java.lang.String secondNumber)
+
+
Takes two phone numbers and compares them for equality. This is a convenience wrapper for + isNumberMatch(PhoneNumber firstNumber, PhoneNumber secondNumber). No default region is known. +

+

+
Parameters:
firstNumber - first number to compare in proto buffer format.
secondNumber - second number to compare. Can contain formatting, and can have country + calling code specified with + at the start. +
Returns:
NOT_A_NUMBER, NO_MATCH, SHORT_NSN_MATCH, NSN_MATCH, EXACT_MATCH. See + isNumberMatch(PhoneNumber firstNumber, PhoneNumber secondNumber) for more details.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/com/google/i18n/phonenumbers/package-frame.html b/javadoc/com/google/i18n/phonenumbers/package-frame.html new file mode 100644 index 0000000..075e056 --- /dev/null +++ b/javadoc/com/google/i18n/phonenumbers/package-frame.html @@ -0,0 +1,68 @@ + + + + + + +com.google.i18n.phonenumbers + + + + + + + + + + + +com.google.i18n.phonenumbers + + + + +
+Classes  + +
+AsYouTypeFormatter +
+PhoneNumberMatch +
+PhoneNumberUtil
+ + + + + + +
+Enums  + +
+NumberParseException.ErrorType +
+PhoneNumberUtil.Leniency +
+PhoneNumberUtil.MatchType +
+PhoneNumberUtil.PhoneNumberFormat +
+PhoneNumberUtil.PhoneNumberType +
+PhoneNumberUtil.ValidationResult
+ + + + + + +
+Exceptions  + +
+NumberParseException
+ + + + diff --git a/javadoc/com/google/i18n/phonenumbers/package-summary.html b/javadoc/com/google/i18n/phonenumbers/package-summary.html new file mode 100644 index 0000000..93ec12e --- /dev/null +++ b/javadoc/com/google/i18n/phonenumbers/package-summary.html @@ -0,0 +1,211 @@ + + + + + + +com.google.i18n.phonenumbers + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package com.google.i18n.phonenumbers +

+ + + + + + + + + + + + + + + + + +
+Class Summary
AsYouTypeFormatterA formatter which formats phone numbers as they are entered.
PhoneNumberMatchThe immutable match of a phone number within a piece of text.
PhoneNumberUtilUtility for international phone numbers.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Summary
NumberParseException.ErrorType 
PhoneNumberUtil.LeniencyLeniency when finding potential phone numbers in text + segments.
PhoneNumberUtil.MatchTypeTypes of phone number matches.
PhoneNumberUtil.PhoneNumberFormatINTERNATIONAL and NATIONAL formats are consistent with the definition in ITU-T Recommendation + E.
PhoneNumberUtil.PhoneNumberTypeType of phone numbers.
PhoneNumberUtil.ValidationResultPossible outcomes when testing if a PhoneNumber is possible.
+  + +

+ + + + + + + + + +
+Exception Summary
NumberParseExceptionGeneric exception class for errors encountered when parsing phone numbers.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/com/google/i18n/phonenumbers/package-tree.html b/javadoc/com/google/i18n/phonenumbers/package-tree.html new file mode 100644 index 0000000..b9273b5 --- /dev/null +++ b/javadoc/com/google/i18n/phonenumbers/package-tree.html @@ -0,0 +1,161 @@ + + + + + + +com.google.i18n.phonenumbers Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package com.google.i18n.phonenumbers +

+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/constant-values.html b/javadoc/constant-values.html new file mode 100644 index 0000000..609d90b --- /dev/null +++ b/javadoc/constant-values.html @@ -0,0 +1,142 @@ + + + + + + +Constant Field Values + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Constant Field Values

+
+
+Contents + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/deprecated-list.html b/javadoc/deprecated-list.html new file mode 100644 index 0000000..40e4ef3 --- /dev/null +++ b/javadoc/deprecated-list.html @@ -0,0 +1,142 @@ + + + + + + +Deprecated List + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Deprecated API

+
+
+Contents + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/help-doc.html b/javadoc/help-doc.html new file mode 100644 index 0000000..cb5c4c9 --- /dev/null +++ b/javadoc/help-doc.html @@ -0,0 +1,209 @@ + + + + + + +API Help + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+How This API Document Is Organized

+
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

+Package

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

+
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object. +
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +This help file applies to API documentation generated using the standard doclet. + +
+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/index-all.html b/javadoc/index-all.html new file mode 100644 index 0000000..9a58375 --- /dev/null +++ b/javadoc/index-all.html @@ -0,0 +1,413 @@ + + + + + + +Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +A C E F G H I N P R S T V
+

+A

+
+
AsYouTypeFormatter - Class in com.google.i18n.phonenumbers
A formatter which formats phone numbers as they are entered.
+
+

+C

+
+
clear() - +Method in class com.google.i18n.phonenumbers.AsYouTypeFormatter +
Clears the internal state of the formatter, so it can be reused. +
com.google.i18n.phonenumbers - package com.google.i18n.phonenumbers
 
convertAlphaCharactersInNumber(String) - +Static method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Converts all alpha characters in a number to their respective digits on a keypad, but retains + existing formatting. +
+
+

+E

+
+
end() - +Method in class com.google.i18n.phonenumbers.PhoneNumberMatch +
Returns the exclusive end index of the matched phone number within the searched text. +
equals(Object) - +Method in class com.google.i18n.phonenumbers.PhoneNumberMatch +
  +
+
+

+F

+
+
findNumbers(CharSequence, String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Returns an iterable over all PhoneNumberMatches in text. +
findNumbers(CharSequence, String, PhoneNumberUtil.Leniency, long) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Returns an iterable over all PhoneNumberMatches in text. +
format(PhoneNumber, PhoneNumberUtil.PhoneNumberFormat) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Formats a phone number in the specified format using default rules. +
format(PhoneNumber, PhoneNumberUtil.PhoneNumberFormat, StringBuilder) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
  +
formatByPattern(PhoneNumber, PhoneNumberUtil.PhoneNumberFormat, List<NumberFormat>) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Formats a phone number in the specified format using client-defined formatting rules. +
formatInOriginalFormat(PhoneNumber, String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Formats a phone number using the original phone number format that the number is parsed from. +
formatNationalNumberWithCarrierCode(PhoneNumber, String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Formats a phone number in national format for dialing using the carrier as specified in the + carrierCode. +
formatNationalNumberWithPreferredCarrierCode(PhoneNumber, String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Formats a phone number in national format for dialing using the carrier as specified in the + preferredDomesticCarrierCode field of the PhoneNumber object passed in. +
formatOutOfCountryCallingNumber(PhoneNumber, String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Formats a phone number for out-of-country dialing purposes. +
formatOutOfCountryKeepingAlphaChars(PhoneNumber, String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Formats a phone number for out-of-country dialing purposes. +
+
+

+G

+
+
getAsYouTypeFormatter(String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Gets an AsYouTypeFormatter for the specific region. +
getCountryCodeForRegion(String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Returns the country calling code for a specific region. +
getErrorType() - +Method in exception com.google.i18n.phonenumbers.NumberParseException +
Returns the error type of the exception that has been thrown. +
getExampleNumber(String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Gets a valid number for the specified region. +
getExampleNumberForType(String, PhoneNumberUtil.PhoneNumberType) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Gets a valid number for the specified region and number type. +
getInstance() - +Static method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Gets a PhoneNumberUtil instance to carry out international phone number formatting, + parsing, or validation. +
getLengthOfGeographicalAreaCode(PhoneNumber) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Gets the length of the geographical area code in the nationalNumber_ field of the + PhoneNumber object passed in, so that clients could use it to split a national significant + number into geographical area code and subscriber number. +
getLengthOfNationalDestinationCode(PhoneNumber) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Gets the length of the national destination code (NDC) from the PhoneNumber object passed in, + so that clients could use it to split a national significant number into NDC and subscriber + number. +
getNationalSignificantNumber(PhoneNumber) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Gets the national significant number of the a phone number. +
getNddPrefixForRegion(String, boolean) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Returns the national dialling prefix for a specific region. +
getNumberType(PhoneNumber) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Gets the type of a phone number. +
getRegionCodeForCountryCode(int) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Returns the region code that matches the specific country calling code. +
getRegionCodeForNumber(PhoneNumber) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Returns the region where a phone number is from. +
getRememberedPosition() - +Method in class com.google.i18n.phonenumbers.AsYouTypeFormatter +
Returns the current position in the partially formatted phone number of the character which was + previously passed in as the parameter of AsYouTypeFormatter.inputDigitAndRememberPosition(char). +
getSupportedRegions() - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Convenience method to enable tests to get a list of what regions the library has metadata for. +
+
+

+H

+
+
hashCode() - +Method in class com.google.i18n.phonenumbers.PhoneNumberMatch +
  +
+
+

+I

+
+
inputDigit(char) - +Method in class com.google.i18n.phonenumbers.AsYouTypeFormatter +
Formats a phone number on-the-fly as each digit is entered. +
inputDigitAndRememberPosition(char) - +Method in class com.google.i18n.phonenumbers.AsYouTypeFormatter +
Same as AsYouTypeFormatter.inputDigit(char), but remembers the position where nextChar is inserted, so + that it can be retrieved later by using AsYouTypeFormatter.getRememberedPosition(). +
isAlphaNumber(String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Checks if the number is a valid vanity (alpha) number such as 800 MICROSOFT. +
isNANPACountry(String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Checks if this is a region under the North American Numbering Plan Administration (NANPA). +
isNumberMatch(PhoneNumber, PhoneNumber) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Takes two phone numbers and compares them for equality. +
isNumberMatch(PhoneNumber, String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Takes two phone numbers and compares them for equality. +
isPossibleNumber(PhoneNumber) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Convenience wrapper around PhoneNumberUtil.isPossibleNumberWithReason(PhoneNumber). +
isPossibleNumber(String, String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Check whether a phone number is a possible number given a number in the form of a string, and + the region where the number could be dialed from. +
isPossibleNumberWithReason(PhoneNumber) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Check whether a phone number is a possible number. +
isValidNumber(PhoneNumber) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Tests whether a phone number matches a valid pattern. +
isValidNumberForRegion(PhoneNumber, String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Tests whether a phone number is valid for a certain region. +
+
+

+N

+
+
normalizeDigitsOnly(String) - +Static method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Normalizes a string of characters representing a phone number. +
number() - +Method in class com.google.i18n.phonenumbers.PhoneNumberMatch +
Returns the phone number matched by the receiver. +
NumberParseException - Exception in com.google.i18n.phonenumbers
Generic exception class for errors encountered when parsing phone numbers.
NumberParseException(NumberParseException.ErrorType, String) - +Constructor for exception com.google.i18n.phonenumbers.NumberParseException +
  +
NumberParseException.ErrorType - Enum in com.google.i18n.phonenumbers
 
+
+

+P

+
+
parse(String, String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Parses a string and returns it in proto buffer format. +
parse(String, String, PhoneNumber) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
  +
parseAndKeepRawInput(String, String) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Parses a string and returns it in proto buffer format. +
parseAndKeepRawInput(String, String, PhoneNumber) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
  +
PhoneNumberMatch - Class in com.google.i18n.phonenumbers
The immutable match of a phone number within a piece of text.
PhoneNumberUtil - Class in com.google.i18n.phonenumbers
Utility for international phone numbers.
PhoneNumberUtil.Leniency - Enum in com.google.i18n.phonenumbers
Leniency when finding potential phone numbers in text + segments.
PhoneNumberUtil.MatchType - Enum in com.google.i18n.phonenumbers
Types of phone number matches.
PhoneNumberUtil.PhoneNumberFormat - Enum in com.google.i18n.phonenumbers
INTERNATIONAL and NATIONAL formats are consistent with the definition in ITU-T Recommendation + E.
PhoneNumberUtil.PhoneNumberType - Enum in com.google.i18n.phonenumbers
Type of phone numbers.
PhoneNumberUtil.ValidationResult - Enum in com.google.i18n.phonenumbers
Possible outcomes when testing if a PhoneNumber is possible.
+
+

+R

+
+
rawString() - +Method in class com.google.i18n.phonenumbers.PhoneNumberMatch +
Returns the raw string matched as a phone number in the searched text. +
+
+

+S

+
+
start() - +Method in class com.google.i18n.phonenumbers.PhoneNumberMatch +
Returns the start index of the matched phone number within the searched text. +
+
+

+T

+
+
toString() - +Method in exception com.google.i18n.phonenumbers.NumberParseException +
  +
toString() - +Method in class com.google.i18n.phonenumbers.PhoneNumberMatch +
  +
truncateTooLongNumber(PhoneNumber) - +Method in class com.google.i18n.phonenumbers.PhoneNumberUtil +
Attempts to extract a valid number from a phone number that is too long to be valid, and resets + the PhoneNumber object passed in to that valid version. +
+
+

+V

+
+
valueOf(String) - +Static method in enum com.google.i18n.phonenumbers.NumberParseException.ErrorType +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum com.google.i18n.phonenumbers.PhoneNumberUtil.Leniency +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum com.google.i18n.phonenumbers.PhoneNumberUtil.MatchType +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum com.google.i18n.phonenumbers.PhoneNumberUtil.PhoneNumberFormat +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum com.google.i18n.phonenumbers.PhoneNumberUtil.PhoneNumberType +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum com.google.i18n.phonenumbers.PhoneNumberUtil.ValidationResult +
Returns the enum constant of this type with the specified name. +
values() - +Static method in enum com.google.i18n.phonenumbers.NumberParseException.ErrorType +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum com.google.i18n.phonenumbers.PhoneNumberUtil.Leniency +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum com.google.i18n.phonenumbers.PhoneNumberUtil.MatchType +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum com.google.i18n.phonenumbers.PhoneNumberUtil.PhoneNumberFormat +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum com.google.i18n.phonenumbers.PhoneNumberUtil.PhoneNumberType +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum com.google.i18n.phonenumbers.PhoneNumberUtil.ValidationResult +
Returns an array containing the constants of this enum type, in +the order they are declared. +
+
+A C E F G H I N P R S T V + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/index.html b/javadoc/index.html new file mode 100644 index 0000000..c016a3c --- /dev/null +++ b/javadoc/index.html @@ -0,0 +1,36 @@ + + + + + + +Generated Documentation (Untitled) + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="com/google/i18n/phonenumbers/package-summary.html">Non-frame version.</A> + + + diff --git a/javadoc/overview-tree.html b/javadoc/overview-tree.html new file mode 100644 index 0000000..b99b016 --- /dev/null +++ b/javadoc/overview-tree.html @@ -0,0 +1,163 @@ + + + + + + +Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For All Packages

+
+
+
Package Hierarchies:
com.google.i18n.phonenumbers
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/package-list b/javadoc/package-list new file mode 100644 index 0000000..b18d1f7 --- /dev/null +++ b/javadoc/package-list @@ -0,0 +1 @@ +com.google.i18n.phonenumbers diff --git a/javadoc/resources/inherit.gif b/javadoc/resources/inherit.gif new file mode 100644 index 0000000000000000000000000000000000000000..c814867a13deb0ca7ea2156c6ca1d5a03372af7e GIT binary patch literal 57 zcmZ?wbhEHbIIT!9-C*e{wE9>Kx3D)-;0v)C; KYxQGgum%9JOA&7X literal 0 HcmV?d00001 diff --git a/javadoc/serialized-form.html b/javadoc/serialized-form.html new file mode 100644 index 0000000..66a5450 --- /dev/null +++ b/javadoc/serialized-form.html @@ -0,0 +1,184 @@ + + + + + + +Serialized Form + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Serialized Form

+
+
+ + + + + +
+Package com.google.i18n.phonenumbers
+ +

+ + + + + +
+Class com.google.i18n.phonenumbers.NumberParseException extends java.lang.Exception implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+errorType

+
+NumberParseException.ErrorType errorType
+
+
+
+
+
+

+message

+
+java.lang.String message
+
+
+
+
+ +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + +
Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/javadoc/stylesheet.css b/javadoc/stylesheet.css new file mode 100644 index 0000000..6ea9e51 --- /dev/null +++ b/javadoc/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + -- 2.7.4