Class PhoneNumber (2.41.0)

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
Type Description
int

EXTENSION_FIELD_NUMBER

public static final int EXTENSION_FIELD_NUMBER
Field Value
Type Description
int

SHORT_CODE_FIELD_NUMBER

public static final int SHORT_CODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PhoneNumber getDefaultInstance()
Returns
Type Description
PhoneNumber

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PhoneNumber.Builder newBuilder()
Returns
Type Description
PhoneNumber.Builder

newBuilder(PhoneNumber prototype)

public static PhoneNumber.Builder newBuilder(PhoneNumber prototype)
Parameter
Name Description
prototype PhoneNumber
Returns
Type Description
PhoneNumber.Builder

parseDelimitedFrom(InputStream input)

public static PhoneNumber parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PhoneNumber
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhoneNumber
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PhoneNumber parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PhoneNumber
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhoneNumber
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PhoneNumber parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PhoneNumber
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhoneNumber
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PhoneNumber parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PhoneNumber
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhoneNumber
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PhoneNumber parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PhoneNumber
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhoneNumber
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PhoneNumber parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PhoneNumber
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhoneNumber
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PhoneNumber> parser()
Returns
Type Description
Parser<PhoneNumber>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PhoneNumber getDefaultInstanceForType()
Returns
Type Description
PhoneNumber

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;

Returns
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;

Returns
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;

Returns
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;

Returns
Type Description
ByteString

The bytes for extension.

getKindCase()

public PhoneNumber.KindCase getKindCase()
Returns
Type Description
PhoneNumber.KindCase

getParserForType()

public Parser<PhoneNumber> getParserForType()
Returns
Type Description
Parser<PhoneNumber>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShortCode()

public PhoneNumber.ShortCode getShortCode()

A short code.

Reference(s):

.google.type.PhoneNumber.ShortCode short_code = 2;

Returns
Type Description
PhoneNumber.ShortCode

The shortCode.

getShortCodeOrBuilder()

public PhoneNumber.ShortCodeOrBuilder getShortCodeOrBuilder()

A short code.

Reference(s):

.google.type.PhoneNumber.ShortCode short_code = 2;

Returns
Type Description
PhoneNumber.ShortCodeOrBuilder

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;

Returns
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;

Returns
Type Description
boolean

Whether the shortCode field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PhoneNumber.Builder newBuilderForType()
Returns
Type Description
PhoneNumber.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PhoneNumber.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PhoneNumber.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PhoneNumber.Builder toBuilder()
Returns
Type Description
PhoneNumber.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException