com.screenscraper.util.parsing.address

Enum AddressParserEnum

java.lang.Object

java.lang.Enum<AddressParserEnum>

com.screenscraper.util.parsing.address.AddressParserEnum

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AddressParserEnum>

public enum AddressParserEnum
extends java.lang.Enum<AddressParserEnum>

Class used to parse US addresses

Version:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
US Parser setup to handle standard US addresses.

Method Summary

Modifier and Type	Method and Description
Address	parse(java.lang.String name) Parses the text as an address and returns it as a Address object
abstract Address	parse(java.lang.String name, AddressParser.ParseHint... hints) Parses the text as an address and returns it as a Address object
static AddressParserEnum	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AddressParserEnum[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

US

public static final AddressParserEnum US

Parser setup to handle standard US addresses. It may work for other locations as well, but is using street names and formats used in the US

Method Detail

values

public static AddressParserEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AddressParserEnum c : AddressParserEnum.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AddressParserEnum valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

parse

@Nullable
 @RequiredVersion(value=1)
public Address parse(@NotNull
                                                            java.lang.String name)

Parses the text as an address and returns it as a Address object

Parameters:

name - The string representing the address

Returns:

The Address object that corresponds to the entered string

Throws:

java.lang.IllegalArgumentException - If the address cannot be parsed

parse

@Nullable
 @RequiredVersion(value=1)
public abstract Address parse(@NotNull
                                                                     java.lang.String name,
                                                                     @NotNull
                                                                     AddressParser.ParseHint... hints)

Parses the text as an address and returns it as a Address object

Parameters:

name - The string representing the address

hints - A set of hints to use when parsing. These are not required but can increase the parse accuracy

Returns:

The Address object that corresponds to the entered string

Throws:

java.lang.IllegalArgumentException - If the address cannot be parsed