USAddressParser

java.lang.Object
- com.screenscraper.util.parsing.address.USAddressParser

All Implemented Interfaces:

AddressParser
```
@RequiredVersion(value=1)
public class USAddressParser
extends java.lang.Object
implements AddressParser
```
Class used to parse US addresses. With some tweaking it can probably parse other similarly styled addresses

Version:

1.1

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class USAddressParser.USAddressParserBuilder
Builder class used to setup a USAddressParser
- Nested classes/interfaces inherited from interface com.screenscraper.util.parsing.address.AddressParser
  AddressParser.ParseHint

Nested Classes
Modifier and Type	Class and Description
`static class`	`USAddressParser.USAddressParserBuilder` Builder class used to setup a `USAddressParser`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.Collection<java.lang.String>`	`DEFAULT_COUNTRIES` A default set of countries
`static java.util.Collection<java.lang.String>`	`DEFAULT_END_ADDRESS_WORDS` A default set of end address words.
`static AddressParser.ParseHint[]`	`DEFAULT_HINTS`
`static java.util.Collection<java.lang.String>`	`DEFAULT_SECONDARY_ADDRESS_LINE_WORDS` A default set of secondary address line indicator words
`static java.util.Collection<java.lang.String>`	`DEFAULT_STATES` A default set of states
`static java.lang.String`	`DEFAULT_ZIP_CODE_PATTERN` The default pattern used for matching a zip code
`static java.lang.String`	`NUMERIC_SUFFIX` The suffix to get numeric values after a street name
`static java.lang.String`	`STANDARD_PREPEND` The standard prepend which is applied to MOST end address word patterns.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes any open resources in use by the parser
`Address`	`parse(java.lang.String address)` Attempts to parse the string given as an address.
`Address`	`parse(java.lang.String address, AddressParser.ParseHint... hints)` Attempts to parse the string given as an address.
`void`	`setAutoCloseAfterScrapeEnds(ScrapingSession session)` Tells the data manager to close when the scrape ends.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_HINTS
```
public static final AddressParser.ParseHint[] DEFAULT_HINTS
```
  - STANDARD_PREPEND
```
public static final java.lang.String STANDARD_PREPEND
```
    The standard prepend which is applied to MOST end address word patterns.
    
    See Also:
    
    Constant Field Values
  - NUMERIC_SUFFIX
```
public static final java.lang.String NUMERIC_SUFFIX
```
    The suffix to get numeric values after a street name
    
    See Also:
    
    Constant Field Values
  - DEFAULT_END_ADDRESS_WORDS
```
public static final java.util.Collection<java.lang.String> DEFAULT_END_ADDRESS_WORDS
```
    A default set of end address words. See http://pe.usps.gov/text/pub28/28apc_002.htm for post office accepted values
  - DEFAULT_SECONDARY_ADDRESS_LINE_WORDS
```
public static final java.util.Collection<java.lang.String> DEFAULT_SECONDARY_ADDRESS_LINE_WORDS
```
    A default set of secondary address line indicator words
  - DEFAULT_COUNTRIES
```
public static final java.util.Collection<java.lang.String> DEFAULT_COUNTRIES
```
    A default set of countries
  - DEFAULT_STATES
```
public static final java.util.Collection<java.lang.String> DEFAULT_STATES
```
    A default set of states
  - DEFAULT_ZIP_CODE_PATTERN
```
public static final java.lang.String DEFAULT_ZIP_CODE_PATTERN
```
    The default pattern used for matching a zip code
    
    See Also:
    
    Constant Field Values
- Method Detail
  - parse
```
@Nullable
public Address parse(@NotNull
                                java.lang.String address)
                         throws java.text.ParseException
```
    Description copied from interface: AddressParser
    
    Attempts to parse the string given as an address.
    
    Specified by:
    
    parse in interface AddressParser
    
    Parameters:
    
    address - The string to parse as an address
    
    Returns:
    
    The Address from the string
    
    Throws:
    
    java.text.ParseException - If there is an error parsing the address. Not throwing the exception doesn't indicate we know the parse has correct data, but there are some cases when we know the parsed data is invalid
  - parse
```
@Nullable
public Address parse(@NotNull
                                java.lang.String address,
                                @NotNull
                                AddressParser.ParseHint... hints)
                         throws java.text.ParseException
```
    Description copied from interface: AddressParser
    
    Attempts to parse the string given as an address.
    
    Specified by:
    
    parse in interface AddressParser
    
    Parameters:
    
    address - The string to parse as an address
    
    hints - The hints to use when parsing
    
    Returns:
    
    The Address from the string
    
    Throws:
    
    java.text.ParseException - If there is an error parsing the address. Not throwing the exception doesn't indicate we know the parse has correct data, but there are some cases when we know the parsed data is invalid
  - close
```
public void close()
```
    Description copied from interface: AddressParser
    
    Closes any open resources in use by the parser
    
    Specified by:
    
    close in interface AddressParser
  - setAutoCloseAfterScrapeEnds
```
public void setAutoCloseAfterScrapeEnds(@NotNull
                                        ScrapingSession session)
```
    Description copied from interface: AddressParser
    
    Tells the data manager to close when the scrape ends. Calling this method will close the data manager automatically when the scrape ends. If the session was stopped, it will clear the data that is set to be written, otherwise it will call flush before closing.
    
    Specified by:
    
    setAutoCloseAfterScrapeEnds in interface AddressParser
    
    Parameters:
    
    session - The scraping session this should use to check for closing on completion

Class USAddressParser

Nested Class Summary

Nested classes/interfaces inherited from interface com.screenscraper.util.parsing.address.AddressParser

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_HINTS

STANDARD_PREPEND

NUMERIC_SUFFIX

DEFAULT_END_ADDRESS_WORDS

DEFAULT_SECONDARY_ADDRESS_LINE_WORDS

DEFAULT_COUNTRIES

DEFAULT_STATES

DEFAULT_ZIP_CODE_PATTERN

Method Detail

parse

parse

close

setAutoCloseAfterScrapeEnds