public static final class PhoneNumber.Builder extends GeneratedMessageV3.Builder<PhoneNumber.Builder> 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 Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PhoneNumber.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public PhoneNumber build()
Returns
buildPartial()
public PhoneNumber buildPartial()
Returns
clear()
public PhoneNumber.Builder clear()
Returns
Overrides
clearE164Number()
public PhoneNumber.Builder clearE164Number()
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;
clearExtension()
public PhoneNumber.Builder clearExtension()
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;
clearField(Descriptors.FieldDescriptor field)
public PhoneNumber.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearKind()
public PhoneNumber.Builder clearKind()
Returns
clearOneof(Descriptors.OneofDescriptor oneof)
public PhoneNumber.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearShortCode()
public PhoneNumber.Builder clearShortCode()
A short code.
Reference(s):
.google.type.PhoneNumber.ShortCode short_code = 2;
clone()
public PhoneNumber.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public PhoneNumber getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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
getShortCode()
public PhoneNumber.ShortCode getShortCode()
A short code.
Reference(s):
.google.type.PhoneNumber.ShortCode short_code = 2;
getShortCodeBuilder()
public PhoneNumber.ShortCode.Builder getShortCodeBuilder()
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;
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
public PhoneNumber.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public PhoneNumber.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeFrom(PhoneNumber other)
public PhoneNumber.Builder mergeFrom(PhoneNumber other)
Parameter
Returns
mergeShortCode(PhoneNumber.ShortCode value)
public PhoneNumber.Builder mergeShortCode(PhoneNumber.ShortCode value)
A short code.
Reference(s):
.google.type.PhoneNumber.ShortCode short_code = 2;
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PhoneNumber.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setE164Number(String value)
public PhoneNumber.Builder setE164Number(String value)
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;
| Name | Description |
| value | String
The e164Number to set.
|
Returns
setE164NumberBytes(ByteString value)
public PhoneNumber.Builder setE164NumberBytes(ByteString value)
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;
| Name | Description |
| value | ByteString
The bytes for e164Number to set.
|
Returns
setExtension(String value)
public PhoneNumber.Builder setExtension(String value)
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;
| Name | Description |
| value | String
The extension to set.
|
Returns
setExtensionBytes(ByteString value)
public PhoneNumber.Builder setExtensionBytes(ByteString value)
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;
| Name | Description |
| value | ByteString
The bytes for extension to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public PhoneNumber.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PhoneNumber.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setShortCode(PhoneNumber.ShortCode value)
public PhoneNumber.Builder setShortCode(PhoneNumber.ShortCode value)
A short code.
Reference(s):
.google.type.PhoneNumber.ShortCode short_code = 2;
setShortCode(PhoneNumber.ShortCode.Builder builderForValue)
public PhoneNumber.Builder setShortCode(PhoneNumber.ShortCode.Builder builderForValue)
A short code.
Reference(s):
.google.type.PhoneNumber.ShortCode short_code = 2;
setUnknownFields(UnknownFieldSet unknownFields)
public final PhoneNumber.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
