Skip navigation links

com.convergin.common.sal.ext.api
Interface Address

All Superinterfaces:

java.lang.Cloneable, Parameterable

public interface Address

extends Parameterable

Method Summary

java.lang.Object	clone() Returns a clone of this Address.
boolean	equals(java.lang.Object o) Compares the given Address with this one.
java.lang.String	getDisplayName() Returns the display name of this Address.
URI	getURI() Returns the URI component of this Address.
void	setDisplayName(java.lang.String displayName) Sets the display name of this Address.
void	setURI(URI uri) Sets the URI of this Address.
java.lang.String	toString() Returns the value of this address as a String.

Methods inherited from interface com.convergin.common.sal.ext.api.Parameterable

getParameter, getParameterNames, getParameters, getValue, removeParameter, setParameter, setValue

Method Detail

getDisplayName

java.lang.String getDisplayName()

Returns the display name of this Address. This is typically a caller or callees real name and may be rendered by a user agent, for example when alerting.

Returns:

display name of this Address, or null if one doesn't exist

setDisplayName

void setDisplayName(java.lang.String displayName)

Sets the display name of this Address.

Parameters:

displayName - the new display name

Throws:

java.lang.IllegalStateException - - if this Address is used in a context where it cannot be modified

getURI

URI getURI()

Returns the URI component of this Address. The result will always be non-null.

Returns:

the URI of this Address

setURI

void setURI(URI uri)

Sets the URI of this Address.

Parameters:

uri - new URI of this Address

Throws:

lang.IllegalStateException - - if this Address is used in a context where it cannot be modified

java.lang.NullPointerException - - on null uri.

toString

java.lang.String toString()

Returns the value of this address as a String. The resulting string must be a valid value of a SIP From or To header.

Overrides:

toString in class java.lang.Object

Returns:

value of this Address as a String

clone

java.lang.Object clone()

Returns a clone of this Address. The cloned Address has identical display name, URI, and parameters. This means the cloned address can be used as an argument to SalFactory.createRequest(SalApplicationSession, String, Address, Address).

Specified by:

clone in interface Parameterable

Returns:

a clone of this Address

equals

boolean equals(java.lang.Object o)

Compares the given Address with this one. As Addresses consist of a URI, an optional display name, and an optional set of name-value parameters, the following rules should be used for comparing them: <nl>

• URI (SipURI, TelURL, etc.) within the Address should be compared based on their respective equals() methods.
• Address parameters should be compared in the same way as URI parameters with no restrictions for well-known URI params.
• display-names should be ignored in the comparison. </nl>

  Specified by:

  equals in interface Parameterable

  Overrides:

  equals in class java.lang.Object

  Parameters:

  o - given Address to be compared with this.

  Returns:

  true if the two Addresses are equal.