org.csapi.jr.se
Class AddressRange

java.lang.Object
  |
  +--org.csapi.jr.se.AddressRange
All Implemented Interfaces:
java.io.Serializable

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

Defines the Sequence of Data Elements that specify a range of addresses. The AddrString defines the actual address information and the structure of the string depends on the Plan. An overview of the AddrString formats can be found at the description of the TpAddress data-type. The difference with TpAddress is that there is no Presentation and Screening elements, the AddrString can contain wildcards and Plan may contain P_ADDRESS_PLAN_ANY. If P_ADDRESS_PLAN_ANY is set then the TpAddressRange will be deemed by the gateway to match any TpAddress. If a specific Plan is set (including P_ADDRESS_PLAN_NOT_PRESENT) then the address plan of the range must be identical to the plan contained in an address for the two to match. Two wildcards are allowed: * which matches zero or more characters and ? which matches exactly one character. For E.164 addresses, * which matches zero or more characters and ? are allowed at the beginning or end. Some examples for E.164 addresses: '123' matches specific number; '123*' matches all numbers starting with 123 (including 123 itself); '123??*' matches all numbers starting with 123 and at least 5 digits long; '123???' matches all numbers starting with 123 and exactly 6 digits long; '*' matches any address The following address ranges are illegal: '1?3' '1*3' '?123*' '' Legal occurrences of the '*' and '?' characters in AddrString should be escaped by a '\' character. To specify a '\' character '\' must be used. For e-mail style addresses, the wildcards are allowed at the beginning of the AddrString: '*@parlay.org' matches all email addresses in the parlay.org domain. For SIP addresses, a range of wildcard options may be supported: 'sip:*@parlay.org' matches all SIP addresses at parlay.org:5060. 'sip:*.domain1.com' Matches all SIP addresses in the domain domain1.com 'sip:user*@*' Matches all users starting with the string 'user' 'sip:user*@*:5060' Matches all users starting with the string 'user' using port 5060 'sip:*' Matches all SIP addresses 'sip:*@*' Matches all SIP addresses 'sip:user*@*:5060' Matches all users starting with the string 'user' using port 5060 In addition for SIP addresses, the absence of an explicit port number at the end of a SIP address, shall be considered to indicate an implicit wildcard for any port number. 'sip:user1@parlay.org' may be considered equivalent to 'sip:user1@parlay.org:*'

See Also:
Serialized Form

Constructor Summary
AddressRange()
          Creates a new AddressRange instance.
AddressRange(org.csapi.jr.se.AddressPlan _plan, java.lang.String _addrString, java.lang.String _name, java.lang.String _subAddressString)
          Creates a new AddressRange instance.
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is 'equal to' this one.
 java.lang.String getAddrString()
          This method returns a addrString.
 java.lang.String getName()
          This method returns a name.
 org.csapi.jr.se.AddressPlan getPlan()
          This method returns a plan.
 java.lang.String getSubAddressString()
          This method returns a subAddressString.
 int hashCode()
          Returns a hashcode value for the object.
 void setAddrString(java.lang.String addrString)
          This method sets a addrString.
 void setName(java.lang.String name)
          This method sets a name.
 void setPlan(org.csapi.jr.se.AddressPlan plan)
          This method sets a plan.
 void setSubAddressString(java.lang.String subAddressString)
          This method sets a subAddressString.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AddressRange

public AddressRange()
Creates a new AddressRange instance.


AddressRange

public AddressRange(org.csapi.jr.se.AddressPlan _plan,
                    java.lang.String _addrString,
                    java.lang.String _name,
                    java.lang.String _subAddressString)
Creates a new AddressRange instance.

Parameters:
_plan -
_addrString -
_name -
_subAddressString -
Method Detail

getPlan

public org.csapi.jr.se.AddressPlan getPlan()
This method returns a plan.

Returns:
a org.csapi.jr.se.AddressPlan value

getAddrString

public java.lang.String getAddrString()
This method returns a addrString.

Returns:
a String value

getName

public java.lang.String getName()
This method returns a name.

Returns:
a String value

getSubAddressString

public java.lang.String getSubAddressString()
This method returns a subAddressString.

Returns:
a String value

setPlan

public void setPlan(org.csapi.jr.se.AddressPlan plan)
This method sets a plan.


setAddrString

public void setAddrString(java.lang.String addrString)
This method sets a addrString.


setName

public void setName(java.lang.String name)
This method sets a name.


setSubAddressString

public void setSubAddressString(java.lang.String subAddressString)
This method sets a subAddressString.


equals

public boolean equals(java.lang.Object o)
Indicates whether some other object is 'equal to' this one.

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Returns a hashcode value for the object.

Overrides:
hashCode in class java.lang.Object