C# Class PhoneNumbers.PhoneNumberUtil

显示文件 Open project: naphaso/kilogram Class Usage Examples

Public Properties

Property	Type	Description
VALID_START_CHAR_PATTERN	PhoneRegex

Public Methods

Method	Description
CanBeInternationallyDialled ( PhoneNumber number ) : bool
ConvertAlphaCharactersInNumber ( String number ) : String
ExtractPossibleNumber ( String number ) : String
FindNumbers ( String text, String defaultRegion ) : IEnumerable
FindNumbers ( String text, String defaultRegion, Leniency leniency, long maxTries ) : IEnumerable
Format ( PhoneNumber number, PhoneNumberFormat numberFormat ) : String
Format ( PhoneNumber number, PhoneNumberFormat numberFormat, StringBuilder formattedNumber ) : void
FormatByPattern ( PhoneNumber number, PhoneNumberFormat numberFormat, List userDefinedFormats ) : String
FormatInOriginalFormat ( PhoneNumber number, String regionCallingFrom ) : String
FormatNationalNumberWithCarrierCode ( PhoneNumber number, String carrierCode ) : String
FormatNationalNumberWithPreferredCarrierCode ( PhoneNumber number, String fallbackCarrierCode ) : String
FormatNumberForMobileDialing ( PhoneNumber number, String regionCallingFrom, bool withFormatting ) : String
FormatOutOfCountryCallingNumber ( PhoneNumber number, String regionCallingFrom ) : String
FormatOutOfCountryKeepingAlphaChars ( PhoneNumber number, String regionCallingFrom ) : String
GetAsYouTypeFormatter ( String regionCode ) : AsYouTypeFormatter
GetCountryCodeForRegion ( String regionCode ) : int
GetExampleNumber ( String regionCode ) : PhoneNumber
GetExampleNumberForNonGeoEntity ( int countryCallingCode ) : PhoneNumber
GetExampleNumberForType ( String regionCode, PhoneNumberType type ) : PhoneNumber
GetInstance ( ) : PhoneNumberUtil
GetInstance ( String baseFileLocation, Dictionary countryCallingCodeToRegionCodeMap ) : PhoneNumberUtil
GetLengthOfGeographicalAreaCode ( PhoneNumber number ) : int
GetLengthOfNationalDestinationCode ( PhoneNumber number ) : int
GetMetadataForNonGeographicalRegion ( int countryCallingCode ) : PhoneMetadata
GetMetadataForRegion ( String regionCode ) : PhoneMetadata
GetNationalSignificantNumber ( PhoneNumber number ) : String
GetNddPrefixForRegion ( String regionCode, bool stripNonDigits ) : String
GetNumberType ( PhoneNumber number ) : PhoneNumberType
GetRegionCodeForCountryCode ( int countryCallingCode ) : String
GetRegionCodeForNumber ( PhoneNumber number ) : String
GetSupportedGlobalNetworkCallingCodes ( ) : PhoneMetadata>.KeyCollection.Dictionary
GetSupportedRegions ( ) : HashSet
IsAlphaNumber ( String number ) : bool
IsLeadingZeroPossible ( int countryCallingCode ) : bool
IsNANPACountry ( String regionCode ) : bool
IsNumberMatch ( PhoneNumber firstNumberIn, PhoneNumber secondNumberIn ) : MatchType
IsNumberMatch ( PhoneNumber firstNumber, String secondNumber ) : MatchType
IsNumberMatch ( String firstNumber, String secondNumber ) : MatchType
IsPossibleNumber ( PhoneNumber number ) : bool
IsPossibleNumber ( String number, String regionDialingFrom ) : bool
IsPossibleNumberWithReason ( PhoneNumber number ) : ValidationResult
IsValidNumber ( PhoneNumber number ) : bool
IsValidNumberForRegion ( PhoneNumber number, String regionCode ) : bool
IsViablePhoneNumber ( String number ) : bool
MaybeExtractCountryCode ( String number, PhoneMetadata defaultRegionMetadata, StringBuilder nationalNumber, bool keepRawInput, PhoneNumber phoneNumber ) : int
MaybeStripInternationalPrefixAndNormalize ( StringBuilder number, String possibleIddPrefix ) : PhoneNumbers.PhoneNumber.Types.CountryCodeSource
MaybeStripNationalPrefixAndCarrierCode ( StringBuilder number, PhoneMetadata metadata, StringBuilder carrierCode ) : bool
Normalize ( String number ) : String
NormalizeDigitsOnly ( String number ) : String
Parse ( String numberToParse, String defaultRegion ) : PhoneNumber
Parse ( String numberToParse, String defaultRegion, PhoneNumber phoneNumber ) : void
ParseAndKeepRawInput ( String numberToParse, String defaultRegion ) : PhoneNumber
ParseAndKeepRawInput ( String numberToParse, String defaultRegion, PhoneNumber phoneNumber ) : void
ResetInstance ( ) : void
TruncateTooLongNumber ( PhoneNumber number ) : bool
Verify ( Leniency leniency, PhoneNumber number, String candidate, PhoneNumberUtil util ) : bool

Private Methods

Method	Description
AreEqual ( PhoneNumber p1, PhoneNumber p2 ) : bool
BuildNationalNumberForParsing ( String numberToParse, StringBuilder nationalNumber ) : void
CheckRegionForParsing ( String numberToParse, String defaultRegion ) : bool
ChooseFormattingPatternForNumber ( IList availableFormats, String nationalNumber ) : NumberFormat
CreateExtnPattern ( String singleExtnSymbols ) : String
ExtractCountryCode ( StringBuilder fullNumber, StringBuilder nationalNumber ) : int
FormatNsn ( String number, PhoneMetadata metadata, PhoneNumberFormat numberFormat ) : String
FormatNsn ( String number, PhoneMetadata metadata, PhoneNumberFormat numberFormat, String carrierCode ) : String
FormatNsnUsingPattern ( String nationalNumber, NumberFormat formattingPattern, PhoneNumberFormat numberFormat ) : String
FormatNsnUsingPattern ( String nationalNumber, NumberFormat formattingPattern, PhoneNumberFormat numberFormat, String carrierCode ) : String
GetCountryCodeForValidRegion ( String regionCode ) : int
GetMetadataForRegionOrCallingCode ( int countryCallingCode, String regionCode ) : PhoneMetadata
GetNumberDescByType ( PhoneMetadata metadata, PhoneNumberType type ) : PhoneNumberDesc
GetNumberTypeHelper ( String nationalNumber, PhoneMetadata metadata ) : PhoneNumberType
GetRegionCodeForNumberFromRegionList ( PhoneNumber number, List regionCodes ) : String
HasFormattingPatternForNumber ( PhoneNumber number ) : bool
HasUnexpectedItalianLeadingZero ( PhoneNumber number ) : bool
HasValidCountryCallingCode ( int countryCallingCode ) : bool
Init ( String filePrefix ) : void
IsNationalNumberSuffixOfTheOther ( PhoneNumber firstNumber, PhoneNumber secondNumber ) : bool
IsNumberMatchingDesc ( String nationalNumber, PhoneNumberDesc numberDesc ) : bool
IsValidRegionCode ( String regionCode ) : bool
LoadMetadataFromFile ( String filePrefix, String regionCode, int countryCallingCode ) : void
MaybeAppendFormattedExtension ( PhoneNumber number, PhoneMetadata metadata, PhoneNumberFormat numberFormat, StringBuilder formattedNumber ) : void
MaybeStripExtension ( StringBuilder number ) : String
Normalize ( StringBuilder number ) : void
NormalizeDigits ( String number, bool keepNonDigits ) : StringBuilder
NormalizeHelper ( String number, char>.Dictionary normalizationReplacements, bool removeNonMatches ) : String
ParseHelper ( String numberToParse, String defaultRegion, bool keepRawInput, bool checkRegion, PhoneNumber phoneNumber ) : void
ParsePrefixAsIdd ( PhoneRegex iddPattern, StringBuilder number ) : bool
PhoneNumberUtil ( ) : System
PrefixNumberWithCountryCallingCode ( int countryCallingCode, PhoneNumberFormat numberFormat, StringBuilder formattedNumber ) : void
RawInputContainsNationalPrefix ( String rawInput, String nationalPrefix, String regionCode ) : bool
TestNumberLengthAgainstPattern ( PhoneRegex numberPattern, String number ) : ValidationResult

Method Details

CanBeInternationallyDialled() public method

public CanBeInternationallyDialled ( PhoneNumber number ) : bool
number	PhoneNumber
return	bool

ConvertAlphaCharactersInNumber() public static method

public static ConvertAlphaCharactersInNumber ( String number ) : String
number	String
return	String

ExtractPossibleNumber() public static method

public static ExtractPossibleNumber ( String number ) : String
number	String
return	String

FindNumbers() public method

public FindNumbers ( String text, String defaultRegion ) : IEnumerable
text	String
defaultRegion	String
return	IEnumerable

FindNumbers() public method

public FindNumbers ( String text, String defaultRegion, Leniency leniency, long maxTries ) : IEnumerable
text	String
defaultRegion	String
leniency	Leniency
maxTries	long
return	IEnumerable

Format() public method

public Format ( PhoneNumber number, PhoneNumberFormat numberFormat ) : String
number	PhoneNumber
numberFormat	PhoneNumberFormat
return	String

Format() public method

public Format ( PhoneNumber number, PhoneNumberFormat numberFormat, StringBuilder formattedNumber ) : void
number	PhoneNumber
numberFormat	PhoneNumberFormat
formattedNumber	StringBuilder
return	void

FormatByPattern() public method

public FormatByPattern ( PhoneNumber number, PhoneNumberFormat numberFormat, List userDefinedFormats ) : String
number	PhoneNumber
numberFormat	PhoneNumberFormat
userDefinedFormats	List
return	String

FormatInOriginalFormat() public method

public FormatInOriginalFormat ( PhoneNumber number, String regionCallingFrom ) : String
number	PhoneNumber
regionCallingFrom	String
return	String

FormatNationalNumberWithCarrierCode() public method

public FormatNationalNumberWithCarrierCode ( PhoneNumber number, String carrierCode ) : String
number	PhoneNumber
carrierCode	String
return	String

FormatNationalNumberWithPreferredCarrierCode() public method

public FormatNationalNumberWithPreferredCarrierCode ( PhoneNumber number, String fallbackCarrierCode ) : String
number	PhoneNumber
fallbackCarrierCode	String
return	String

FormatNumberForMobileDialing() public method

public FormatNumberForMobileDialing ( PhoneNumber number, String regionCallingFrom, bool withFormatting ) : String
number	PhoneNumber
regionCallingFrom	String
withFormatting	bool
return	String

FormatOutOfCountryCallingNumber() public method

public FormatOutOfCountryCallingNumber ( PhoneNumber number, String regionCallingFrom ) : String
number	PhoneNumber
regionCallingFrom	String
return	String

FormatOutOfCountryKeepingAlphaChars() public method

public FormatOutOfCountryKeepingAlphaChars ( PhoneNumber number, String regionCallingFrom ) : String
number	PhoneNumber
regionCallingFrom	String
return	String

GetAsYouTypeFormatter() public method

public GetAsYouTypeFormatter ( String regionCode ) : AsYouTypeFormatter
regionCode	String
return	AsYouTypeFormatter

GetCountryCodeForRegion() public method

public GetCountryCodeForRegion ( String regionCode ) : int
regionCode	String
return	int

GetExampleNumber() public method

public GetExampleNumber ( String regionCode ) : PhoneNumber
regionCode	String
return	PhoneNumber

GetExampleNumberForNonGeoEntity() public method

public GetExampleNumberForNonGeoEntity ( int countryCallingCode ) : PhoneNumber
countryCallingCode	int
return	PhoneNumber

GetExampleNumberForType() public method

public GetExampleNumberForType ( String regionCode, PhoneNumberType type ) : PhoneNumber
regionCode	String
type	PhoneNumberType
return	PhoneNumber

GetInstance() public static method

public static GetInstance ( ) : PhoneNumberUtil
return	PhoneNumberUtil

GetInstance() public static method

public static GetInstance ( String baseFileLocation, Dictionary countryCallingCodeToRegionCodeMap ) : PhoneNumberUtil
baseFileLocation	String
countryCallingCodeToRegionCodeMap	Dictionary
return	PhoneNumberUtil

GetLengthOfGeographicalAreaCode() public method

public GetLengthOfGeographicalAreaCode ( PhoneNumber number ) : int
number	PhoneNumber
return	int

GetLengthOfNationalDestinationCode() public method

public GetLengthOfNationalDestinationCode ( PhoneNumber number ) : int
number	PhoneNumber
return	int

GetMetadataForNonGeographicalRegion() public method

public GetMetadataForNonGeographicalRegion ( int countryCallingCode ) : PhoneMetadata
countryCallingCode	int
return	PhoneMetadata

GetMetadataForRegion() public method

public GetMetadataForRegion ( String regionCode ) : PhoneMetadata
regionCode	String
return	PhoneMetadata

GetNationalSignificantNumber() public method

public GetNationalSignificantNumber ( PhoneNumber number ) : String
number	PhoneNumber
return	String

GetNddPrefixForRegion() public method

public GetNddPrefixForRegion ( String regionCode, bool stripNonDigits ) : String
regionCode	String
stripNonDigits	bool
return	String

GetNumberType() public method

public GetNumberType ( PhoneNumber number ) : PhoneNumberType
number	PhoneNumber
return	PhoneNumberType

GetRegionCodeForCountryCode() public method

public GetRegionCodeForCountryCode ( int countryCallingCode ) : String
countryCallingCode	int
return	String

GetRegionCodeForNumber() public method

public GetRegionCodeForNumber ( PhoneNumber number ) : String
number	PhoneNumber
return	String

GetSupportedGlobalNetworkCallingCodes() public method

public GetSupportedGlobalNetworkCallingCodes ( ) : PhoneMetadata>.KeyCollection.Dictionary
return	PhoneMetadata>.KeyCollection.Dictionary

GetSupportedRegions() public method

public GetSupportedRegions ( ) : HashSet
return	HashSet

IsAlphaNumber() public method

public IsAlphaNumber ( String number ) : bool
number	String
return	bool

IsLeadingZeroPossible() public method

public IsLeadingZeroPossible ( int countryCallingCode ) : bool
countryCallingCode	int
return	bool

IsNANPACountry() public method

public IsNANPACountry ( String regionCode ) : bool
regionCode	String
return	bool

IsNumberMatch() public method

public IsNumberMatch ( PhoneNumber firstNumberIn, PhoneNumber secondNumberIn ) : MatchType
firstNumberIn	PhoneNumber
secondNumberIn	PhoneNumber
return	MatchType

IsNumberMatch() public method

public IsNumberMatch ( PhoneNumber firstNumber, String secondNumber ) : MatchType
firstNumber	PhoneNumber
secondNumber	String
return	MatchType

IsNumberMatch() public method

public IsNumberMatch ( String firstNumber, String secondNumber ) : MatchType
firstNumber	String
secondNumber	String
return	MatchType

IsPossibleNumber() public method

public IsPossibleNumber ( PhoneNumber number ) : bool
number	PhoneNumber
return	bool

IsPossibleNumber() public method

public IsPossibleNumber ( String number, String regionDialingFrom ) : bool
number	String
regionDialingFrom	String
return	bool

IsPossibleNumberWithReason() public method

public IsPossibleNumberWithReason ( PhoneNumber number ) : ValidationResult
number	PhoneNumber
return	ValidationResult

IsValidNumber() public method

public IsValidNumber ( PhoneNumber number ) : bool
number	PhoneNumber
return	bool

IsValidNumberForRegion() public method

public IsValidNumberForRegion ( PhoneNumber number, String regionCode ) : bool
number	PhoneNumber
regionCode	String
return	bool

IsViablePhoneNumber() public static method

public static IsViablePhoneNumber ( String number ) : bool
number	String
return	bool

MaybeExtractCountryCode() public method

public MaybeExtractCountryCode ( String number, PhoneMetadata defaultRegionMetadata, StringBuilder nationalNumber, bool keepRawInput, PhoneNumber phoneNumber ) : int
number	String
defaultRegionMetadata	PhoneMetadata
nationalNumber	StringBuilder
keepRawInput	bool
phoneNumber	PhoneNumber
return	int

MaybeStripInternationalPrefixAndNormalize() public method

public MaybeStripInternationalPrefixAndNormalize ( StringBuilder number, String possibleIddPrefix ) : PhoneNumbers.PhoneNumber.Types.CountryCodeSource
number	StringBuilder
possibleIddPrefix	String
return	PhoneNumbers.PhoneNumber.Types.CountryCodeSource

MaybeStripNationalPrefixAndCarrierCode() public method

public MaybeStripNationalPrefixAndCarrierCode ( StringBuilder number, PhoneMetadata metadata, StringBuilder carrierCode ) : bool
number	StringBuilder
metadata	PhoneMetadata
carrierCode	StringBuilder
return	bool

Normalize() public static method

public static Normalize ( String number ) : String
number	String
return	String

NormalizeDigitsOnly() public static method

public static NormalizeDigitsOnly ( String number ) : String
number	String
return	String

Parse() public method

public Parse ( String numberToParse, String defaultRegion ) : PhoneNumber
numberToParse	String
defaultRegion	String
return	PhoneNumber

Parse() public method

public Parse ( String numberToParse, String defaultRegion, PhoneNumber phoneNumber ) : void
numberToParse	String
defaultRegion	String
phoneNumber	PhoneNumber
return	void

ParseAndKeepRawInput() public method

public ParseAndKeepRawInput ( String numberToParse, String defaultRegion ) : PhoneNumber
numberToParse	String
defaultRegion	String
return	PhoneNumber

ParseAndKeepRawInput() public method

public ParseAndKeepRawInput ( String numberToParse, String defaultRegion, PhoneNumber phoneNumber ) : void
numberToParse	String
defaultRegion	String
phoneNumber	PhoneNumber
return	void

ResetInstance() public static method

public static ResetInstance ( ) : void
return	void

TruncateTooLongNumber() public method

public TruncateTooLongNumber ( PhoneNumber number ) : bool
number	PhoneNumber
return	bool

Verify() public method

public Verify ( Leniency leniency, PhoneNumber number, String candidate, PhoneNumberUtil util ) : bool
leniency	Leniency
number	PhoneNumber
candidate	String
util	PhoneNumberUtil
return	bool

Property Details

VALID_START_CHAR_PATTERN public_oe static_oe property

public static PhoneRegex,PhoneNumbers VALID_START_CHAR_PATTERN
return	PhoneRegex