Class PhoneNumber (2.37.1)

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
TypeDescription
int

EXTENSION_FIELD_NUMBER

public static final int EXTENSION_FIELD_NUMBER
Field Value
TypeDescription
int

SHORT_CODE_FIELD_NUMBER

public static final int SHORT_CODE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PhoneNumber getDefaultInstance()
Returns
TypeDescription
PhoneNumber

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PhoneNumber.Builder newBuilder()
Returns
TypeDescription
PhoneNumber.Builder

newBuilder(PhoneNumber prototype)

public static PhoneNumber.Builder newBuilder(PhoneNumber prototype)
Parameter
NameDescription
prototypePhoneNumber
Returns
TypeDescription
PhoneNumber.Builder

parseDelimitedFrom(InputStream input)

public static PhoneNumber parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PhoneNumber
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PhoneNumber
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PhoneNumber parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PhoneNumber
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PhoneNumber
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PhoneNumber parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PhoneNumber
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PhoneNumber
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PhoneNumber parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PhoneNumber
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PhoneNumber
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PhoneNumber parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PhoneNumber
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PhoneNumber
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PhoneNumber parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PhoneNumber
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PhoneNumber
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PhoneNumber> parser()
Returns
TypeDescription
Parser<PhoneNumber>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PhoneNumber getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for extension.

getKindCase()

public PhoneNumber.KindCase getKindCase()
Returns
TypeDescription
PhoneNumber.KindCase

getParserForType()

public Parser<PhoneNumber> getParserForType()
Returns
TypeDescription
Parser<PhoneNumber>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getShortCode()

public PhoneNumber.ShortCode getShortCode()

A short code.

Reference(s):

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

Returns
TypeDescription
PhoneNumber.ShortCode

The shortCode.

getShortCodeOrBuilder()

public PhoneNumber.ShortCodeOrBuilder getShortCodeOrBuilder()

A short code.

Reference(s):

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the e164Number field is set.

hasShortCode()

public boolean hasShortCode()

A short code.

Reference(s):

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

Returns
TypeDescription
boolean

Whether the shortCode field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PhoneNumber.Builder newBuilderForType()
Returns
TypeDescription
PhoneNumber.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PhoneNumber.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PhoneNumber.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PhoneNumber.Builder toBuilder()
Returns
TypeDescription
PhoneNumber.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException