javax.slee
Class AddressPlan

java.lang.Object
  |
  +--javax.slee.AddressPlan
All Implemented Interfaces:
java.io.Serializable

public final class AddressPlan
extends java.lang.Object
implements java.io.Serializable

This class defines an enumerated type that encapsulates the values available for address or numbering plans. An address plan specifies the format and structure of an associated address string. A numbering plan typically consists of decimal digits segmented into groups in order to identify specific elements used for identification, routing, and charging capabilities.

A singleton instance of each enumerated value is guaranteed (via an implementation of readResolve() - refer java.io.Serializable), so that equality tests using == are always evaluated correctly. (This equality test is only guaranteed if this class is loaded in the application's boot class path, rather than dynamically loaded at runtime.)

See Also:
Address, Serialized Form

Field Summary
static int ADDRESS_PLAN_AESA
          An integer representation of AESA.
static int ADDRESS_PLAN_E164
          An integer representation of E164.
static int ADDRESS_PLAN_E164_MOBILE
          An integer representation of E164_MOBILE.
static int ADDRESS_PLAN_GT
          An integer representation of GT.
static int ADDRESS_PLAN_H323
          An integer representation of H323.
static int ADDRESS_PLAN_IP
          An integer representation of IP.
static int ADDRESS_PLAN_MULTICAST
          An integer representation of MULTICAST.
static int ADDRESS_PLAN_NOT_PRESENT
          An integer representation of NOT_PRESENT.
static int ADDRESS_PLAN_NSAP
          An integer representation of NSAP.
static int ADDRESS_PLAN_SIP
          An integer representation of SIP.
static int ADDRESS_PLAN_SLEE_PROFILE
          An integer representation of SLEE_PROFILE.
static int ADDRESS_PLAN_SLEE_PROFILE_TABLE
          An integer representation of SLEE_PROFILE_TABLE.
static int ADDRESS_PLAN_SMTP
          An integer representation of SMTP.
static int ADDRESS_PLAN_SSN
          An integer representation of SSN.
static int ADDRESS_PLAN_UNDEFINED
          An integer representation of UNDEFINED.
static int ADDRESS_PLAN_UNICAST
          An integer representation of UNICAST.
static int ADDRESS_PLAN_URI
          An integer representation of URI.
static int ADDRESS_PLAN_X400
          An integer representation of X400.
static AddressPlan AESA
          The AESA value indicates that the address is an ATM End System Address in binary format (40 bytes).
static AddressPlan E164
          The E164 value indicates that the address is an international number without the international access code, but including the country code and area code (without the leading zero).
static AddressPlan E164_MOBILE
          The E164_MOBILE value indicates that the address is an E.164 mobile number.
static AddressPlan GT
          The GT value indicates that the address is a Global Title.
static AddressPlan H323
          The H323 value indicates that the address is an H.323 address.
static AddressPlan IP
          The IP value indicates that the address is an IP address in dotted notation.
static AddressPlan MULTICAST
          The MULTICAST value indicates that the address is an IP address in dotted notation that is either an IPv4 class D address or an equivalent IPv6 address.
static AddressPlan NOT_PRESENT
          The NOT_PRESENT value indicates that the address is not present.
static AddressPlan NSAP
          The NSAP value indicates that the address is a binary representation of a Network Service Access Point.
static AddressPlan SIP
          The SIP value indicates that the address is a Session Initiation Protocol address as specified in IETF RFC 2543.
static AddressPlan SLEE_PROFILE
          The SLEE_PROFILE value indicates that the address is the encoded table name and profile name of a SLEE profile.
static AddressPlan SLEE_PROFILE_TABLE
          The SLEE_PROFILE_TABLE value indicates that the address is the name of SLEE profile table.
static AddressPlan SMTP
          The SMTP value indicates that the address is an email address as defined in IETF RFC 822.
static AddressPlan SSN
          The SSN value indicates that the address is a Sub System Number.
static AddressPlan UNDEFINED
          The UNDEFINED value indicates that the address is undefined.
static AddressPlan UNICAST
          The UNICAST value indicates that the address is an IP address in dotted notation that is not a multicast or broadcast address.
static AddressPlan URI
          The URI value indicates that the address is a uniform resource locator as defined in IETF RFC 2396.
static AddressPlan X400
          The X400 value indicates that the address is an X400 address structured as a set of attribute value pairs separated by semicolons.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Compare this address plan for equality with another.
static AddressPlan fromInt(int plan)
          Get an AddressPlan object from an integer value.
 int hashCode()
          Get a hash code value for this address plan.
 boolean isAESA()
          Determine if this AddressPlan object represents the AESA address plan value.
 boolean isE164()
          Determine if this AddressPlan object represents the E164 address plan value.
 boolean isE164Mobile()
          Determine if this AddressPlan object represents the E164_MOBILE address plan value.
 boolean isGT()
          Determine if this AddressPlan object represents the GT address plan value.
 boolean isH323()
          Determine if this AddressPlan object represents the H323 address plan value.
 boolean isIP()
          Determine if this AddressPlan object represents the IP address plan value.
 boolean isMulticast()
          Determine if this AddressPlan object represents the MULTICAST address plan value.
 boolean isNotPresent()
          Determine if this AddressPlan object represents the NOT_PRESENT address plan value.
 boolean isNSAP()
          Determine if this AddressPlan object represents the NSAP address plan value.
 boolean isSIP()
          Determine if this AddressPlan object represents the SIP address plan value.
 boolean isSleeProfile()
          Determine if this AddressPlan object represents the SLEE_PROFILE address plan value.
 boolean isSleeProfileTable()
          Determine if this AddressPlan object represents the SLEE_PROFILE_TABLE address plan value.
 boolean isSMTP()
          Determine if this AddressPlan object represents the SMTP address plan value.
 boolean isSSN()
          Determine if this AddressPlan object represents the SSN address plan value.
 boolean isUndefined()
          Determine if this AddressPlan object represents the UNDEFINED address plan value.
 boolean isUnicast()
          Determine if this AddressPlan object represents the UNICAST address plan value.
 boolean isURI()
          Determine if this AddressPlan object represents the URI address plan value.
 boolean isX400()
          Determine if this AddressPlan object represents the X400 address plan value.
 int toInt()
          Get an integer value representation for this AddressPlan object.
 java.lang.String toString()
          Get the textual representation of the address plan object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ADDRESS_PLAN_NOT_PRESENT

public static final int ADDRESS_PLAN_NOT_PRESENT
An integer representation of NOT_PRESENT.

ADDRESS_PLAN_UNDEFINED

public static final int ADDRESS_PLAN_UNDEFINED
An integer representation of UNDEFINED.

ADDRESS_PLAN_IP

public static final int ADDRESS_PLAN_IP
An integer representation of IP.

ADDRESS_PLAN_MULTICAST

public static final int ADDRESS_PLAN_MULTICAST
An integer representation of MULTICAST.

ADDRESS_PLAN_UNICAST

public static final int ADDRESS_PLAN_UNICAST
An integer representation of UNICAST.

ADDRESS_PLAN_E164

public static final int ADDRESS_PLAN_E164
An integer representation of E164.

ADDRESS_PLAN_AESA

public static final int ADDRESS_PLAN_AESA
An integer representation of AESA.

ADDRESS_PLAN_URI

public static final int ADDRESS_PLAN_URI
An integer representation of URI.

ADDRESS_PLAN_NSAP

public static final int ADDRESS_PLAN_NSAP
An integer representation of NSAP.

ADDRESS_PLAN_SMTP

public static final int ADDRESS_PLAN_SMTP
An integer representation of SMTP.

ADDRESS_PLAN_X400

public static final int ADDRESS_PLAN_X400
An integer representation of X400.

ADDRESS_PLAN_SIP

public static final int ADDRESS_PLAN_SIP
An integer representation of SIP.

ADDRESS_PLAN_E164_MOBILE

public static final int ADDRESS_PLAN_E164_MOBILE
An integer representation of E164_MOBILE.

ADDRESS_PLAN_H323

public static final int ADDRESS_PLAN_H323
An integer representation of H323.

ADDRESS_PLAN_GT

public static final int ADDRESS_PLAN_GT
An integer representation of GT.

ADDRESS_PLAN_SSN

public static final int ADDRESS_PLAN_SSN
An integer representation of SSN.

ADDRESS_PLAN_SLEE_PROFILE_TABLE

public static final int ADDRESS_PLAN_SLEE_PROFILE_TABLE
An integer representation of SLEE_PROFILE_TABLE.

ADDRESS_PLAN_SLEE_PROFILE

public static final int ADDRESS_PLAN_SLEE_PROFILE
An integer representation of SLEE_PROFILE.

NOT_PRESENT

public static final AddressPlan NOT_PRESENT
The NOT_PRESENT value indicates that the address is not present.

UNDEFINED

public static final AddressPlan UNDEFINED
The UNDEFINED value indicates that the address is undefined.

IP

public static final AddressPlan IP
The IP value indicates that the address is an IP address in dotted notation.

MULTICAST

public static final AddressPlan MULTICAST
The MULTICAST value indicates that the address is an IP address in dotted notation that is either an IPv4 class D address or an equivalent IPv6 address.

UNICAST

public static final AddressPlan UNICAST
The UNICAST value indicates that the address is an IP address in dotted notation that is not a multicast or broadcast address.

E164

public static final AddressPlan E164
The E164 value indicates that the address is an international number without the international access code, but including the country code and area code (without the leading zero).

AESA

public static final AddressPlan AESA
The AESA value indicates that the address is an ATM End System Address in binary format (40 bytes).

URI

public static final AddressPlan URI
The URI value indicates that the address is a uniform resource locator as defined in IETF RFC 2396.

NSAP

public static final AddressPlan NSAP
The NSAP value indicates that the address is a binary representation of a Network Service Access Point.

SMTP

public static final AddressPlan SMTP
The SMTP value indicates that the address is an email address as defined in IETF RFC 822.

E164_MOBILE

public static final AddressPlan E164_MOBILE
The E164_MOBILE value indicates that the address is an E.164 mobile number.

X400

public static final AddressPlan X400
The X400 value indicates that the address is an X400 address structured as a set of attribute value pairs separated by semicolons.

SIP

public static final AddressPlan SIP
The SIP value indicates that the address is a Session Initiation Protocol address as specified in IETF RFC 2543.

H323

public static final AddressPlan H323
The H323 value indicates that the address is an H.323 address. An H.323 address may be identified by a list of addresses of different types, including URLs.

GT

public static final AddressPlan GT
The GT value indicates that the address is a Global Title.

SSN

public static final AddressPlan SSN
The SSN value indicates that the address is a Sub System Number.

SLEE_PROFILE_TABLE

public static final AddressPlan SLEE_PROFILE_TABLE
The SLEE_PROFILE_TABLE value indicates that the address is the name of SLEE profile table.

SLEE_PROFILE

public static final AddressPlan SLEE_PROFILE
The SLEE_PROFILE value indicates that the address is the encoded table name and profile name of a SLEE profile.
Method Detail

fromInt

public static AddressPlan fromInt(int plan)
                           throws java.lang.IllegalArgumentException
Get an AddressPlan object from an integer value.
Parameters:
plan - the address plan as an integer.
Returns:
an AddressPlan object corresponding to plan.
Throws:
java.lang.IllegalArgumentException - if plan is not a valid address plan value.

toInt

public int toInt()
Get an integer value representation for this AddressPlan object.
Returns:
an integer value representation for this AddressPlan object.

isNotPresent

public boolean isNotPresent()
Determine if this AddressPlan object represents the NOT_PRESENT address plan value.

This method is effectively equivalent to the conditional test: (this == NOT_PRESENT), ie. the code:

    if (plan.isNotPresent()) ...

is interchangeable with the code:

   if (plan == AddressPlan.NOT_PRESENT) ...

Returns:
true if this object represents the NOT_PRESENT address plan value, false otherwise.

isUndefined

public boolean isUndefined()
Determine if this AddressPlan object represents the UNDEFINED address plan value.

This method is effectively equivalent to the conditional test: (this == UNDEFINED), ie. the code:

    if (plan.isUndefined()) ...

is interchangeable with the code:

   if (plan == AddressPlan.UNDEFINED) ...

Returns:
true if this object represents the UNDEFINED address plan value, false otherwise.

isIP

public boolean isIP()
Determine if this AddressPlan object represents the IP address plan value.

This method is effectively equivalent to the conditional test: (this == IP), ie. the code:

    if (plan.isIP()) ...

is interchangeable with the code:

   if (plan == AddressPlan.IP) ...

Returns:
true if this object represents the IP address plan value, false otherwise.

isMulticast

public boolean isMulticast()
Determine if this AddressPlan object represents the MULTICAST address plan value.

This method is effectively equivalent to the conditional test: (this == MULTICAST), ie. the code:

    if (plan.isMulticast()) ...

is interchangeable with the code:

   if (plan == AddressPlan.MULTICAST) ...

Returns:
true if this object represents the MULTICAST address plan value, false otherwise.

isUnicast

public boolean isUnicast()
Determine if this AddressPlan object represents the UNICAST address plan value.

This method is effectively equivalent to the conditional test: (this == UNICAST), ie. the code:

    if (plan.isUnicast()) ...

is interchangeable with the code:

   if (plan == AddressPlan.UNICAST) ...

Returns:
true if this object represents the UNICAST address plan value, false otherwise.

isE164

public boolean isE164()
Determine if this AddressPlan object represents the E164 address plan value.

This method is effectively equivalent to the conditional test: (this == E164), ie. the code:

    if (plan.isE164()) ...

is interchangeable with the code:

   if (plan == AddressPlan.E164) ...

Returns:
true if this object represents the E164 address plan value, false otherwise.

isAESA

public boolean isAESA()
Determine if this AddressPlan object represents the AESA address plan value.

This method is effectively equivalent to the conditional test: (this == AESA), ie. the code:

    if (plan.isAESA()) ...

is interchangeable with the code:

   if (plan == AddressPlan.AESA) ...

Returns:
true if this object represents the AESA address plan value, false otherwise.

isURI

public boolean isURI()
Determine if this AddressPlan object represents the URI address plan value.

This method is effectively equivalent to the conditional test: (this == URI), ie. the code:

    if (plan.isURI()) ...

is interchangeable with the code:

   if (plan == AddressPlan.URI) ...

Returns:
true if this object represents the URI address plan value, false otherwise.

isNSAP

public boolean isNSAP()
Determine if this AddressPlan object represents the NSAP address plan value.

This method is effectively equivalent to the conditional test: (this == NSAP), ie. the code:

    if (plan.isNSAP()) ...

is interchangeable with the code:

   if (plan == AddressPlan.NSAP) ...

Returns:
true if this object represents the NSAP address plan value, false otherwise.

isSMTP

public boolean isSMTP()
Determine if this AddressPlan object represents the SMTP address plan value.

This method is effectively equivalent to the conditional test: (this == SMTP), ie. the code:

    if (plan.isSMTP()) ...

is interchangeable with the code:

   if (plan == AddressPlan.SMTP) ...

Returns:
true if this object represents the SMTP address plan value, false otherwise.

isX400

public boolean isX400()
Determine if this AddressPlan object represents the X400 address plan value.

This method is effectively equivalent to the conditional test: (this == X400), ie. the code:

    if (plan.isX400()) ...

is interchangeable with the code:

   if (plan == AddressPlan.X400) ...

Returns:
true if this object represents the X400 address plan value, false otherwise.

isSIP

public boolean isSIP()
Determine if this AddressPlan object represents the SIP address plan value.

This method is effectively equivalent to the conditional test: (this == SIP), ie. the code:

    if (plan.isSIP()) ...

is interchangeable with the code:

   if (plan == AddressPlan.SIP) ...

Returns:
true if this object represents the SIP address plan value, false otherwise.

isE164Mobile

public boolean isE164Mobile()
Determine if this AddressPlan object represents the E164_MOBILE address plan value.

This method is effectively equivalent to the conditional test: (this == E164_MOBILE), ie. the code:

    if (plan.isE164Mobile()) ...

is interchangeable with the code:

   if (plan == AddressPlan.E164_MOBILE) ...

Returns:
true if this object represents the E164_MOBILE address plan value, false otherwise.

isH323

public boolean isH323()
Determine if this AddressPlan object represents the H323 address plan value.

This method is effectively equivalent to the conditional test: (this == H323), ie. the code:

    if (plan.isH323()) ...

is interchangeable with the code:

   if (plan == AddressPlan.H323) ...

Returns:
true if this object represents the H323 address plan value, false otherwise.

isGT

public boolean isGT()
Determine if this AddressPlan object represents the GT address plan value.

This method is effectively equivalent to the conditional test: (this == GT), ie. the code:

    if (plan.isGT()) ...

is interchangeable with the code:

   if (plan == AddressPlan.GT) ...

Returns:
true if this object represents the GT address plan value, false otherwise.

isSSN

public boolean isSSN()
Determine if this AddressPlan object represents the SSN address plan value.

This method is effectively equivalent to the conditional test: (this == SSN), ie. the code:

    if (plan.isSSN()) ...

is interchangeable with the code:

   if (plan == AddressPlan.SSN) ...

Returns:
true if this object represents the SSN address plan value, false otherwise.

isSleeProfileTable

public boolean isSleeProfileTable()
Determine if this AddressPlan object represents the SLEE_PROFILE_TABLE address plan value.

This method is effectively equivalent to the conditional test: (this == SLEE_PROFILE_TABLE), ie. the code:

    if (plan.isSleeProfileTable()) ...

is interchangeable with the code:

   if (plan == AddressPlan.SLEE_PROFILE_TABLE) ...

Returns:
true if this object represents the SLEE_PROFILE_TABLE address plan value, false otherwise.

isSleeProfile

public boolean isSleeProfile()
Determine if this AddressPlan object represents the SLEE_PROFILE address plan value.

This method is effectively equivalent to the conditional test: (this == SLEE_PROFILE), ie. the code:

    if (plan.isSleeProfile()) ...

is interchangeable with the code:

   if (plan == AddressPlan.SLEE_PROFILE) ...

Returns:
true if this object represents the SLEE_PROFILE address plan value, false otherwise.

equals

public boolean equals(java.lang.Object obj)
Compare this address plan for equality with another.
Overrides:
equals in class java.lang.Object
Parameters:
obj - the object to compare this with.
Returns:
true if obj is an instance of this class representing the same address plan value as this, false otherwise.

hashCode

public int hashCode()
Get a hash code value for this address plan.
Overrides:
hashCode in class java.lang.Object
Returns:
a hash code value.

toString

public java.lang.String toString()
Get the textual representation of the address plan object.
Overrides:
toString in class java.lang.Object
Returns:
the textual representation of the address plan object.