Package com.google.type

Class PhoneNumber.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<PhoneNumber,PhoneNumber.Builder>
com.google.type.PhoneNumber.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, PhoneNumberOrBuilder, Cloneable
Enclosing class:
PhoneNumber
public static final class PhoneNumber.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<PhoneNumber,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

  • Field Summary

    Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder

    instance

  • Method Summary

    Modifier and Type
    Method
    Description
    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".
    PhoneNumber.Builder
    clearExtension()
    The phone number's extension.
    PhoneNumber.Builder
    clearKind()
     
    PhoneNumber.Builder
    clearShortCode()
    A short code.
    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".
    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".
    String
    getExtension()
    The phone number's extension.
    com.google.protobuf.ByteString
    getExtensionBytes()
    The phone number's extension.
    PhoneNumber.KindCase
    getKindCase()
     
    PhoneNumber.ShortCode
    getShortCode()
    A short code.
    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".
    boolean
    hasShortCode()
    A short code.
    PhoneNumber.Builder
    mergeShortCode(PhoneNumber.ShortCode value)
    A short code.
    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".
    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".
    PhoneNumber.Builder
    setExtension(String value)
    The phone number's extension.
    PhoneNumber.Builder
    setExtensionBytes(com.google.protobuf.ByteString value)
    The phone number's extension.
    PhoneNumber.Builder
    setShortCode(PhoneNumber.ShortCode value)
    A short code.
    PhoneNumber.Builder
    setShortCode(PhoneNumber.ShortCode.Builder builderForValue)
    A short code.

    Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder

    build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFrom

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • 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 [json_name = "e164Number"];
      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 [json_name = "e164Number"];
      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 [json_name = "e164Number"];
      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 [json_name = "e164Number"];
      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 [json_name = "e164Number"];
      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 [json_name = "e164Number"];
      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 [json_name = "shortCode"];
      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 [json_name = "shortCode"];
      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 [json_name = "shortCode"];

    • 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 [json_name = "shortCode"];

    • 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 [json_name = "shortCode"];

    • clearShortCode

      public PhoneNumber.Builder clearShortCode()
       A short code.

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

    • 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 [json_name = "extension"];
      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 [json_name = "extension"];
      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 [json_name = "extension"];
      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 [json_name = "extension"];
      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 [json_name = "extension"];
      Parameters:
      value - The bytes for extension to set.
      Returns:
      This builder for chaining.