public final class PhoneNumber extends GeneratedMessageV3 implements PhoneNumberOrBuilder
An object representing a phone number, suitable as an API wire format.
This representation:
- should not be used for locale-specific formatting of a phone number, such
as "+1 (650) 253-0000 ext. 123"
- is not designed for efficient storage
- may not be suitable for dialing - specialized libraries (see references)
should be used to parse the number for that purpose
To do something meaningful with this number, such as format it for various
use-cases, convert it to an
i18n.phonenumbers.PhoneNumber object first.
For instance, in Java this would be:
com.google.type.PhoneNumber wireProto =
com.google.type.PhoneNumber.newBuilder().build();
com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber =
PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ");
if (!wireProto.getExtension().isEmpty()) {
phoneNumber.setExtension(wireProto.getExtension());
}
Reference(s):
Protobuf type google.type.PhoneNumber
Static Fields
E164_NUMBER_FIELD_NUMBER
public static final int E164_NUMBER_FIELD_NUMBER
Field Value
EXTENSION_FIELD_NUMBER
public static final int EXTENSION_FIELD_NUMBER
Field Value
SHORT_CODE_FIELD_NUMBER
public static final int SHORT_CODE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PhoneNumber getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static PhoneNumber.Builder newBuilder()
Returns
newBuilder(PhoneNumber prototype)
public static PhoneNumber.Builder newBuilder(PhoneNumber prototype)
Parameter
Returns
public static PhoneNumber parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static PhoneNumber parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PhoneNumber parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PhoneNumber parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PhoneNumber parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PhoneNumber parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PhoneNumber parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static PhoneNumber parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PhoneNumber parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static PhoneNumber parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PhoneNumber parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PhoneNumber parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PhoneNumber> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public PhoneNumber getDefaultInstanceForType()
Returns
getE164Number()
public String getE164Number()
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
string e164_number = 1;
| Type | Description |
| String | The e164Number.
|
getE164NumberBytes()
public ByteString getE164NumberBytes()
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
string e164_number = 1;
| Type | Description |
| ByteString | The bytes for e164Number.
|
getExtension()
public String getExtension()
The phone number's extension. The extension is not standardized in ITU
recommendations, except for being defined as a series of numbers with a
maximum length of 40 digits. Other than digits, some other dialing
characters such as ',' (indicating a wait) or '#' may be stored here.
Note that no regions currently use extensions with short codes, so this
field is normally only set in conjunction with an E.164 number. It is held
separately from the E.164 number to allow for short code extensions in the
future.
string extension = 3;
| Type | Description |
| String | The extension.
|
getExtensionBytes()
public ByteString getExtensionBytes()
The phone number's extension. The extension is not standardized in ITU
recommendations, except for being defined as a series of numbers with a
maximum length of 40 digits. Other than digits, some other dialing
characters such as ',' (indicating a wait) or '#' may be stored here.
Note that no regions currently use extensions with short codes, so this
field is normally only set in conjunction with an E.164 number. It is held
separately from the E.164 number to allow for short code extensions in the
future.
string extension = 3;
getKindCase()
public PhoneNumber.KindCase getKindCase()
Returns
getParserForType()
public Parser<PhoneNumber> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getShortCode()
public PhoneNumber.ShortCode getShortCode()
A short code.
Reference(s):
.google.type.PhoneNumber.ShortCode short_code = 2;
getShortCodeOrBuilder()
public PhoneNumber.ShortCodeOrBuilder getShortCodeOrBuilder()
A short code.
Reference(s):
.google.type.PhoneNumber.ShortCode short_code = 2;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasE164Number()
public boolean hasE164Number()
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
string e164_number = 1;
| Type | Description |
| boolean | Whether the e164Number field is set.
|
hasShortCode()
public boolean hasShortCode()
A short code.
Reference(s):
.google.type.PhoneNumber.ShortCode short_code = 2;
| Type | Description |
| boolean | Whether the shortCode field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public PhoneNumber.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PhoneNumber.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public PhoneNumber.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
