javax.sip.address

Interface Address

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

AddressImpl

public interface Address
extends Cloneable, Serializable

This interface represents a user's display name and URI address. The display name of an address is optional but if included can be displayed to an end-user. The address URI (most likely a SipURI) is the user's address. For example a 'To' address of To: Bob sip:[email protected] would have a display name attribute of Bob and an address of sip:[email protected].

Version:

1.2

Author:

BEA Systems, NIST

See Also:

SipURI, TelURL

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Clone method.
boolean	equals(Object obj) Indicates whether some other Object is "equal to" this Address.
String	getDisplayName() Gets the display name of this Address, or null if the attribute is not set.
URI	getURI() Returns the URI of this Address.
int	hashCode() Gets a hash code value for this address.
boolean	isWildcard() This determines if this address is a wildcard address.
void	setDisplayName(String displayName) Sets the display name of the Address.
void	setURI(URI uri) Sets the URI of this Address.
String	toString() Returns a string representation of this Address.

Method Detail

setDisplayName

void setDisplayName(String displayName)
                    throws ParseException

Sets the display name of the Address. The display name is an additional user friendly personalized text that accompanies the address.

Parameters:

displayName - - the new string value of the display name.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the displayName value.

getDisplayName

String getDisplayName()

Gets the display name of this Address, or null if the attribute is not set.

Returns:

the display name of this Address

setURI

void setURI(URI uri)

Sets the URI of this Address. The URI can be either a TelURL or a SipURI.

Parameters:

uri - - the new URI value of this Address.

getURI

URI getURI()

Returns the URI of this Address. The type of URI can be determined by the scheme.

Returns:

URI parmater of the Address object

toString

String toString()

Returns a string representation of this Address.

Overrides:

toString in class Object

Returns:

the stringified representation of the Address

equals

boolean equals(Object obj)

Indicates whether some other Object is "equal to" this Address. The actual implementation class of a Address object must override the Object.equals method. The new equals method must ensure that the implementation of the method is reflexive, symmetric, transitive and for any non null value X, X.equals(null) returns false.

Overrides:

equals in class Object

Parameters:

obj - - the Object with which to compare this Address

Returns:

true if this Address is "equal to" the object argument and false otherwise.

See Also:

Object

hashCode

int hashCode()

Gets a hash code value for this address. Implementations MUST implement a hashCode method that overrides the default hash code method for Objects comparision.

Overrides:

hashCode in class Object

Returns:

a hash code value.

Since:

v1.2

isWildcard

boolean isWildcard()

This determines if this address is a wildcard address. That is ((SipURI)Address.getURI()).getUser() == *;. This method is specific to SIP and SIPS schemes.

Returns:

true if this address is a wildcard, false otherwise.

clone

Object clone()

Clone method. An implementation is expected to override the default Object.clone method and return a "deep clone".

Since:

v1.2