Package com.storedobject.common

Class USAddress

java.lang.Object

com.storedobject.common.Address

com.storedobject.common.USAddress

public class USAddress
extends Address

US Address
line[0]: Code for the state.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
USAddress()

Method Summary

Modifier and Type	Method	Description
String	getAreaCaption()	Get the caption for the "area" line.
String	getCity()	Retrieves the city name for this USAddress.
int	getExtraLines()	Get the number of extra lines.
String	getPostalCodeCaption()	Get the caption for the Postal Code.
int	getPostalCodeMaxLength()	What is the maximum length of the postal code?
int	getPostalCodeMinLength()	What is the minimum length of the postal code?
int	getState()	Get the state index.
String	getStateCode()	Retrieves the state code of the given USAddress.
String	getStateName()	Returns the name of the state for this USAddress.
static Stream<String>	getStates()	Get the name of the states.
String	getZIPCode()	Retrieves the ZIP code for this USAddress.
boolean	isNumericPostalCode()	Whether the postal code is numeric or not.
boolean	isPostalCodeMandatory()	Is postal code mandatory?
void	setState(int state)	Set the state.
void	setState(String state)	Set the state.

Methods inherited from class com.storedobject.common.Address

arrangeLines, check, check, copy, create, create, encode, getApartmentName, getAreaName, getBuildingName, getCountry, getHouseName, getLine, getOfficeName, getPOBox, getPOBoxName, getPostalCode, getStreetName, getType, getTypeValue, getTypeValue, getTypeValues, getVillaName, isPOBoxAddress, isPostalCodeAddress, isValid, poBoxPrefix, poBoxSuffix, setApartmentName, setAreaName, setBuildingName, setHouseName, setLine, setOfficeName, setPOBox, setPostalCode, setStreetName, setType, setVillaName, toString, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Details

USAddress

public USAddress()

Method Details

getExtraLines

public int getExtraLines()

Description copied from class: Address

Get the number of extra lines.

Overrides:

getExtraLines in class Address

Returns:

Number of extra lines in the address.

getAreaCaption

public String getAreaCaption()

Description copied from class: Address

Get the caption for the "area" line.

Overrides:

getAreaCaption in class Address

Returns:

Default implementation returns "Area".

setState

public void setState(int state)

Set the state.

Parameters:

state - Index values of the state.

setState

public void setState(String state)

Set the state.

Parameters:

state - 2-character state code..

getState

public int getState()
             throws SOException

Get the state index.

Returns:

Index value of the state.

Throws:

SOException - If state index is currently invalid.

getStates

public static Stream<String> getStates()

Get the name of the states.

Returns:

Stream of the state names.

getPostalCodeCaption

public String getPostalCodeCaption()

Description copied from class: Address

Get the caption for the Postal Code.

Overrides:

getPostalCodeCaption in class Address

Returns:

Default implementation returns "Postal Code".

getPostalCodeMinLength

public int getPostalCodeMinLength()

Description copied from class: Address

What is the minimum length of the postal code?

Overrides:

getPostalCodeMinLength in class Address

Returns:

Minimum required length of the postal code.

getPostalCodeMaxLength

public int getPostalCodeMaxLength()

Description copied from class: Address

What is the maximum length of the postal code?

Overrides:

getPostalCodeMaxLength in class Address

Returns:

Maximum required length of the postal code.

isPostalCodeMandatory

public boolean isPostalCodeMandatory()

Description copied from class: Address

Is postal code mandatory?

Overrides:

isPostalCodeMandatory in class Address

Returns:

True/false.

isNumericPostalCode

public boolean isNumericPostalCode()

Description copied from class: Address

Whether the postal code is numeric or not.

Overrides:

isNumericPostalCode in class Address

Returns:

True if numeric. False if alpha-numeric.

getStateName

public String getStateName()

Returns the name of the state for this USAddress.

Returns:

The name of the state.

getStateCode

public String getStateCode()

Retrieves the state code of the given USAddress.

Returns:

The two-character state code of the address. Returns an empty string if no ZIP is available.

getZIPCode

public String getZIPCode()

Retrieves the ZIP code for this USAddress.

Returns:

The ZIP code.

getCity

public String getCity()

Retrieves the city name for this USAddress.

Returns:

The city name.