Package com.google.type

Class PhoneNumber.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>
com.google.type.PhoneNumber.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PhoneNumberOrBuilder, Cloneable
Enclosing class:
PhoneNumber
public static final class PhoneNumber.Builder extends com.google.protobuf.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):
   - https://github.com/google/libphonenumber
Protobuf type google.type.PhoneNumber

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>

    • clear

      public PhoneNumber.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>

    • getDefaultInstanceForType

      public PhoneNumber getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public PhoneNumber build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public PhoneNumber buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public PhoneNumber.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>

    • setField

      public PhoneNumber.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>

    • clearField

      public PhoneNumber.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>

    • clearOneof

      public PhoneNumber.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>

    • setRepeatedField

      public PhoneNumber.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>

    • addRepeatedField

      public PhoneNumber.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>

    • mergeFrom

      public PhoneNumber.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PhoneNumber.Builder>

    • mergeFrom

      public PhoneNumber.Builder mergeFrom(PhoneNumber other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>

    • mergeFrom

      public PhoneNumber.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PhoneNumber.Builder>
      Throws:
      IOException

    • getKindCase

      public PhoneNumber.KindCase getKindCase()
      Specified by:
      getKindCase in interface PhoneNumberOrBuilder

    • clearKind

      public PhoneNumber.Builder clearKind()

    • 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.:
  - correct: "+15552220123"
  - incorrect: "+1 (555) 222-01234 x123".

 The ITU E.164 format limits the latter to 12 digits, but in practice not
 all countries respect that, so we relax that restriction here.
 National-only numbers are not allowed.

 References:
  - https://www.itu.int/rec/T-REC-E.164-201011-I
  - https://en.wikipedia.org/wiki/E.164.
  - https://en.wikipedia.org/wiki/List_of_country_calling_codes
      string e164_number = 1;
      Specified by:
      hasE164Number in interface PhoneNumberOrBuilder
      Returns:
      Whether the e164Number field is set.

    • 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.:
  - correct: "+15552220123"
  - incorrect: "+1 (555) 222-01234 x123".

 The ITU E.164 format limits the latter to 12 digits, but in practice not
 all countries respect that, so we relax that restriction here.
 National-only numbers are not allowed.

 References:
  - https://www.itu.int/rec/T-REC-E.164-201011-I
  - https://en.wikipedia.org/wiki/E.164.
  - https://en.wikipedia.org/wiki/List_of_country_calling_codes
      string e164_number = 1;
      Specified by:
      getE164Number in interface PhoneNumberOrBuilder
      Returns:
      The e164Number.

    • getE164NumberBytes

      public com.google.protobuf.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.:
  - correct: "+15552220123"
  - incorrect: "+1 (555) 222-01234 x123".

 The ITU E.164 format limits the latter to 12 digits, but in practice not
 all countries respect that, so we relax that restriction here.
 National-only numbers are not allowed.

 References:
  - https://www.itu.int/rec/T-REC-E.164-201011-I
  - https://en.wikipedia.org/wiki/E.164.
  - https://en.wikipedia.org/wiki/List_of_country_calling_codes
      string e164_number = 1;
      Specified by:
      getE164NumberBytes in interface PhoneNumberOrBuilder
      Returns:
      The bytes for e164Number.

    • setE164Number

      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.:
  - correct: "+15552220123"
  - incorrect: "+1 (555) 222-01234 x123".

 The ITU E.164 format limits the latter to 12 digits, but in practice not
 all countries respect that, so we relax that restriction here.
 National-only numbers are not allowed.

 References:
  - https://www.itu.int/rec/T-REC-E.164-201011-I
  - https://en.wikipedia.org/wiki/E.164.
  - https://en.wikipedia.org/wiki/List_of_country_calling_codes
      string e164_number = 1;
      Parameters:
      value - The e164Number to set.
      Returns:
      This builder for chaining.

    • 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.:
  - correct: "+15552220123"
  - incorrect: "+1 (555) 222-01234 x123".

 The ITU E.164 format limits the latter to 12 digits, but in practice not
 all countries respect that, so we relax that restriction here.
 National-only numbers are not allowed.

 References:
  - https://www.itu.int/rec/T-REC-E.164-201011-I
  - https://en.wikipedia.org/wiki/E.164.
  - https://en.wikipedia.org/wiki/List_of_country_calling_codes
      string e164_number = 1;
      Returns:
      This builder for chaining.

    • setE164NumberBytes

      public PhoneNumber.Builder setE164NumberBytes(com.google.protobuf.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.:
  - correct: "+15552220123"
  - incorrect: "+1 (555) 222-01234 x123".

 The ITU E.164 format limits the latter to 12 digits, but in practice not
 all countries respect that, so we relax that restriction here.
 National-only numbers are not allowed.

 References:
  - https://www.itu.int/rec/T-REC-E.164-201011-I
  - https://en.wikipedia.org/wiki/E.164.
  - https://en.wikipedia.org/wiki/List_of_country_calling_codes
      string e164_number = 1;
      Parameters:
      value - The bytes for e164Number to set.
      Returns:
      This builder for chaining.

    • hasShortCode

      public boolean hasShortCode()
       A short code.

 Reference(s):
  - https://en.wikipedia.org/wiki/Short_code
      .google.type.PhoneNumber.ShortCode short_code = 2;
      Specified by:
      hasShortCode in interface PhoneNumberOrBuilder
      Returns:
      Whether the shortCode field is set.

    • getShortCode

      public PhoneNumber.ShortCode getShortCode()
       A short code.

 Reference(s):
  - https://en.wikipedia.org/wiki/Short_code
      .google.type.PhoneNumber.ShortCode short_code = 2;
      Specified by:
      getShortCode in interface PhoneNumberOrBuilder
      Returns:
      The shortCode.

    • setShortCode

      public PhoneNumber.Builder setShortCode(PhoneNumber.ShortCode value)
       A short code.

 Reference(s):
  - https://en.wikipedia.org/wiki/Short_code
      .google.type.PhoneNumber.ShortCode short_code = 2;

    • setShortCode

      public PhoneNumber.Builder setShortCode(PhoneNumber.ShortCode.Builder builderForValue)
       A short code.

 Reference(s):
  - https://en.wikipedia.org/wiki/Short_code
      .google.type.PhoneNumber.ShortCode short_code = 2;

    • mergeShortCode

      public PhoneNumber.Builder mergeShortCode(PhoneNumber.ShortCode value)
       A short code.

 Reference(s):
  - https://en.wikipedia.org/wiki/Short_code
      .google.type.PhoneNumber.ShortCode short_code = 2;

    • clearShortCode

      public PhoneNumber.Builder clearShortCode()
       A short code.

 Reference(s):
  - https://en.wikipedia.org/wiki/Short_code
      .google.type.PhoneNumber.ShortCode short_code = 2;

    • getShortCodeBuilder

      public PhoneNumber.ShortCode.Builder getShortCodeBuilder()
       A short code.

 Reference(s):
  - https://en.wikipedia.org/wiki/Short_code
      .google.type.PhoneNumber.ShortCode short_code = 2;

    • getShortCodeOrBuilder

      public PhoneNumber.ShortCodeOrBuilder getShortCodeOrBuilder()
       A short code.

 Reference(s):
  - https://en.wikipedia.org/wiki/Short_code
      .google.type.PhoneNumber.ShortCode short_code = 2;
      Specified by:
      getShortCodeOrBuilder in interface PhoneNumberOrBuilder

    • 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;
      Specified by:
      getExtension in interface PhoneNumberOrBuilder
      Returns:
      The extension.

    • getExtensionBytes

      public com.google.protobuf.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;
      Specified by:
      getExtensionBytes in interface PhoneNumberOrBuilder
      Returns:
      The bytes for extension.

    • setExtension

      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;
      Parameters:
      value - The extension to set.
      Returns:
      This builder for chaining.

    • 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;
      Returns:
      This builder for chaining.

    • setExtensionBytes

      public PhoneNumber.Builder setExtensionBytes(com.google.protobuf.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;
      Parameters:
      value - The bytes for extension to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final PhoneNumber.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>

    • mergeUnknownFields

      public final PhoneNumber.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PhoneNumber.Builder>