com.screenscraper.util.parsing.address

Class Address

java.lang.Object

com.screenscraper.util.parsing.address.Address

public class Address
extends java.lang.Object

Represents an address

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
Address(java.lang.String street, java.lang.String city, java.lang.String state, java.lang.String zipCode) Create an address with the given values
Address(java.lang.String street, java.lang.String suiteOrApartment, java.lang.String city, java.lang.String state, java.lang.String zipCode) Create an address with the given values
Address(java.lang.String street, java.lang.String suiteOrApartment, java.lang.String city, java.lang.String state, java.lang.String zipCode, java.lang.String county, java.lang.String country) Create an address with the given values

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getAddressee() Returns the addressee
java.lang.String	getCity() Returns the city
java.lang.String	getCountry() Returns the country
java.lang.String	getCounty() Returns the county
java.lang.String	getState() Returns the state
java.lang.String	getStreet() Returns the street
java.lang.String	getSuiteOrApartment() Returns the suite or apartment
java.lang.String	getZipCode() Returns the zip code
int	hashCode()
void	setAddressee(java.lang.String addressee) Sets the addressee
void	setCity(java.lang.String city) Sets the city
void	setCountry(java.lang.String country) Sets the country
void	setCounty(java.lang.String county) Sets the county
void	setState(java.lang.String state) Sets the state
void	setStreet(java.lang.String street) Sets the street
void	setSuiteOrApartment(java.lang.String suiteOrApartment) Sets the suite or apartment
void	setZipCode(java.lang.String zipCode) Sets the zip code
java.lang.String	toComponentString() Returns a string that clearly shows what the value of each part of the address is, rather than the correctly formatted address
java.lang.String	toString()
java.lang.String	toWellFormattedString() Outputs the address as it would appear on a letter.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Address

public Address(java.lang.String street,
               java.lang.String city,
               java.lang.String state,
               java.lang.String zipCode)

Create an address with the given values

Parameters:

street - The street address

city - The city

state - The state

zipCode - The zip code

Address

public Address(@Nullable
               java.lang.String street,
               @Nullable
               java.lang.String suiteOrApartment,
               @Nullable
               java.lang.String city,
               @Nullable
               java.lang.String state,
               @Nullable
               java.lang.String zipCode)

Create an address with the given values

Parameters:

street - The street address

suiteOrApartment - The suite or apartment. This is just the second address line, if there should be one

city - The city

state - The state

zipCode - The zip code

Address

public Address(@Nullable
               java.lang.String street,
               @Nullable
               java.lang.String suiteOrApartment,
               @Nullable
               java.lang.String city,
               @Nullable
               java.lang.String state,
               @Nullable
               java.lang.String zipCode,
               @Nullable
               java.lang.String county,
               @Nullable
               java.lang.String country)

Create an address with the given values

Parameters:

street - The street address

suiteOrApartment - The suite or apartment. This is just the second address line, if there should be one

city - The city

state - The state

zipCode - The zip code

county - The county

country - The country

Method Detail

getAddressee

@Nullable
public java.lang.String getAddressee()

Returns the addressee

Returns:

The addressee

setAddressee

public void setAddressee(@Nullable
                         java.lang.String addressee)

Sets the addressee

Parameters:

addressee - The addressee

getStreet

@Nullable
public java.lang.String getStreet()

Returns the street

Returns:

The street

setStreet

public void setStreet(java.lang.String street)

Sets the street

Parameters:

street - The street

getSuiteOrApartment

@Nullable
public java.lang.String getSuiteOrApartment()

Returns the suite or apartment

Returns:

The suite or apartment

setSuiteOrApartment

public void setSuiteOrApartment(java.lang.String suiteOrApartment)

Sets the suite or apartment

Parameters:

suiteOrApartment - The suite or apartment

getCity

@Nullable
public java.lang.String getCity()

Returns the city

Returns:

The city

setCity

public void setCity(java.lang.String city)

Sets the city

Parameters:

city - The city

getState

@Nullable
public java.lang.String getState()

Returns the state

Returns:

The state

setState

public void setState(java.lang.String state)

Sets the state

Parameters:

state - The state

getZipCode

@Nullable
public java.lang.String getZipCode()

Returns the zip code

Returns:

The zip code

setZipCode

public void setZipCode(java.lang.String zipCode)

Sets the zip code

Parameters:

zipCode - The zip code

getCounty

@Nullable
public java.lang.String getCounty()

Returns the county

Returns:

The county

setCounty

public void setCounty(java.lang.String county)

Sets the county

Parameters:

county - The county

getCountry

@Nullable
public java.lang.String getCountry()

Returns the country

Returns:

The country

setCountry

public void setCountry(java.lang.String country)

Sets the country

Parameters:

country - The country

toWellFormattedString

@NotNull
public java.lang.String toWellFormattedString()

Outputs the address as it would appear on a letter. In other words, it will be formatted correctly.

Returns:

The address as it would appear on a letter

toComponentString

@NotNull
public java.lang.String toComponentString()

Returns a string that clearly shows what the value of each part of the address is, rather than the correctly formatted address

Returns:

A string showing the value of each address part

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object