| javax.sip.address.Address
| Address | | public interface Address extends Cloneable,Serializable(Code) | | 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:duke@jcp.org would have a display
name attribute of Bob and an address of
sip:duke@jcp.org.
See Also: SipURI
See Also: TelURL
author:
BEA Systems, NIST
version:
1.2 |
| Method Summary | |
| public Object | clone()
Clone method. | | public 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. | | public String | getDisplayName()
Gets the display name of this Address, or null if the attribute is
not set. | | public URI | getURI()
Returns the URI of this Address. | | public int | hashCode()
Gets a hash code value for this address. | | public boolean | isWildcard()
This determines if this address is a wildcard address. | | public void | setDisplayName(String displayName)
Sets the display name of the Address. | | public void | setURI(URI uri)
Sets the URI of this Address. | | public String | toString()
Returns a string representation of this Address. |
| clone | | public Object clone()(Code) | | Clone method. An implementation is expected to override the default
Object.clone method and return a "deep clone".
since:
v1.2 |
| equals | | public boolean equals(Object obj)(Code) | | 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.
Parameters:
obj - - the Object with which to compare this Address true if this Address is "equal to" the object argument andfalse otherwise.
See Also: Object |
| getDisplayName | | public String getDisplayName()(Code) | | Gets the display name of this Address, or null if the attribute is
not set.
the display name of this Address |
| getURI | | public URI getURI()(Code) | | Returns the URI of this Address. The type of URI can be
determined by the scheme.
URI parmater of the Address object |
| hashCode | | public int hashCode()(Code) | | Gets a hash code value for this address. Implementations MUST
implement a hashCode method that overrides the default hash code
method for Objects comparision.
a hash code value.
since:
v1.2 |
| isWildcard | | public boolean isWildcard()(Code) | | This determines if this address is a wildcard address. That is
((SipURI)Address.getURI()).getUser() == *;. This method
is specific to SIP and SIPS schemes.
true if this address is a wildcard, false otherwise. |
| setDisplayName | | public void setDisplayName(String displayName) throws ParseException(Code) | | 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 reachedunexpectedly while parsing the displayName value. |
| setURI | | public void setURI(URI uri)(Code) | | 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. |
| toString | | public String toString()(Code) | | Returns a string representation of this Address.
the stringified representation of the Address |
|
|