public class Address extends Object implements Serializable
Address
class encapsulates an address that can be used by the SLEE.
An address consists of the following two components:
An Address
object is immutable. Once it has been created the values
contained by it cannot change.
Valid Addresses The valid values for address strings is dependent on the address plan for an address. The following is a list of valid address strings for each address plan:
Constructor and Description |
---|
Address(AddressPlan addressPlan,
String addressString)
Create a new
Address using an address plan and address string. |
Address(AddressPlan addressPlan,
String addressString,
AddressPresentation addressPresentation,
AddressScreening addressScreening,
String subAddressString,
String addressName)
Create a new
Address using an address plan, an address string, an
additional optional attributes. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Compare this address object for equality with another.
|
String |
getAddressName()
Get the optional address name for the address.
|
AddressPlan |
getAddressPlan()
Get the address plan for the address.
|
AddressPresentation |
getAddressPresentation()
Get the optional address presentation attribute for the address.
|
AddressScreening |
getAddressScreening()
Get the optional address screening attribute for the address.
|
String |
getAddressString()
Get the address string for the address.
|
String |
getSubAddressString()
Get the optional sub-address string for the address.
|
int |
hashCode()
Get a hash code value for this address object.
|
String |
toString()
Get the textual representation of the address object.
|
public Address(AddressPlan addressPlan, String addressString)
Address
using an address plan and address string.addressPlan
- the address plan for this address.addressString
- the address string for this address.NullPointerException
- if either addressPlan
or
addressString
is null
.IllegalArgumentException
- if addressString
is zero-length.public Address(AddressPlan addressPlan, String addressString, AddressPresentation addressPresentation, AddressScreening addressScreening, String subAddressString, String addressName)
Address
using an address plan, an address string, an
additional optional attributes.addressPlan
- the address plan for this address.addressString
- the address string for this address.addressPresentation
- an optional argument describing whether the address
can be presented to other call parties.addressScreening
- an optional argument describing whether the address has
been screened by a user application.subAddressString
- an optional argument that provides a sub-address string
for protocols that allow sub-addressing.addressName
- an optional argument that allows a more personal name to be
associated with the address.NullPointerException
- if either addressPlan
or
addressString
is null
.IllegalArgumentException
- if addressString
is zero-length.public AddressPlan getAddressPlan()
public String getAddressString()
public AddressPresentation getAddressPresentation()
null
if no address
presentation attribute was specified.public AddressScreening getAddressScreening()
null
if no address
screening attribute was specified.public String getSubAddressString()
null
if no sub-address string
was specified.public String getAddressName()
null
if no address name was specified.public boolean equals(Object obj)
public int hashCode()