gov.nist.javax.sip.address

Class AddressImpl

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.address.NetObject

gov.nist.javax.sip.address.AddressImpl

All Implemented Interfaces:

Serializable, Cloneable, Address

public final class AddressImpl
extends NetObject
implements Address

Address structure. Imbeds a URI and adds a display name.

Version:

1.2 $Revision: 1.14 $ $Date: 2010-07-27 10:55:29 $

Author:

M. Ranganathan

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected GenericURI	address address field
static int	ADDRESS_SPEC constant field.
protected int	addressType
protected String	displayName displayName field
static int	NAME_ADDR Constant field.
static int	WILD_CARD Constant field.

Fields inherited from class gov.nist.javax.sip.address.NetObject

CORE_PACKAGE, GRUU, LR, MADDR, METHOD, NET_PACKAGE, PARSER_PACKAGE, PHONE, SIP, SIPS, TCP, TLS, TRANSPORT, TTL, UDP, USER

Fields inherited from class gov.nist.core.GenericObject

AND, AT, COLON, COMMA, DOT, DOUBLE_QUOTE, EQUALS, GREATER_THAN, HT, immutableClasses, indentation, LESS_THAN, LPAREN, matchExpression, NEWLINE, PERCENT, POUND, QUESTION, QUOTE, RETURN, RPAREN, SEMICOLON, SLASH, SP, STAR, stringRepresentation

Constructor Summary

Constructors

Constructor and Description
AddressImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Clones this object.
String	encode() Encode the address as a string and return it.
StringBuilder	encode(StringBuilder buffer) Put the encoded version of this object in the given StringBuilder.
boolean	equals(Object other) Compare two address specs for equality.
int	getAddressType() Get the address type;
String	getDisplayName() get the display name
String	getHost() Get the host name from the address.
HostPort	getHostPort() Get the host port portion of the address spec.
int	getPort() Get the port from the imbedded URI.
URI	getURI() Returns the URI address of this Address.
String	getUserAtHostPort() Get the user@host:port for the address field.
boolean	hasDisplayName() return true if DisplayName exist.
int	hashCode() hashCode impelmentation
boolean	isSIPAddress() Return true if the imbedded URI is a sip URI.
boolean	isWildcard() This determines if this address is a wildcard address.
boolean	match(Object other) Match on the address only.
void	removeDisplayName() remove the displayName field
void	removeParameter(String parameterName) Remove a parameter from the address.
void	setAddess(URI address) Set the address field
void	setAddressType(int atype) Set the address type.
void	setDisplayName(String displayName) Set the displayName member
void	setURI(URI address) Sets the URI address of this Address.
void	setUser(String user) Set the user name for the imbedded URI.
void	setWildCardFlag() Mark this a wild card address type.

Methods inherited from class gov.nist.javax.sip.address.NetObject

debugDump, debugDump, toString

Methods inherited from class gov.nist.core.GenericObject

dbgPrint, dbgPrint, getClassFromName, getIndentation, getMatcher, isMySubclass, makeClone, merge, setMatcher, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.sip.address.Address

toString

Field Detail

NAME_ADDR

public static final int NAME_ADDR

Constant field.

See Also:

Constant Field Values

ADDRESS_SPEC

public static final int ADDRESS_SPEC

constant field.

See Also:

Constant Field Values

WILD_CARD

public static final int WILD_CARD

Constant field.

See Also:

Constant Field Values

addressType

protected int addressType

displayName

protected String displayName

displayName field

address

protected GenericURI address

address field

Constructor Detail

AddressImpl

public AddressImpl()

Method Detail

match

public boolean match(Object other)

Match on the address only. Dont care about the display name.

Overrides:

match in class NetObject

Parameters:

other - the match pattern to test against. The match object has to be of the same type (class). Primitive types and non-sip fields that are non null are matched for equality. Null in any field matches anything. Some book-keeping fields are ignored when making the comparison.

Returns:

true if match succeeds false otherwise.

getHostPort

public HostPort getHostPort()

Get the host port portion of the address spec.

Returns:

host:port in a HostPort structure.

getPort

public int getPort()

Get the port from the imbedded URI. This assumes that a SIP URL is encapsulated in this address object.

Returns:

the port from the address.

getUserAtHostPort

public String getUserAtHostPort()

Get the user@host:port for the address field. This assumes that the encapsulated object is a SipUri.

Returns:

string containing user@host:port.

getHost

public String getHost()

Get the host name from the address.

Returns:

the host name.

removeParameter

public void removeParameter(String parameterName)

Remove a parameter from the address.

Parameters:

parameterName - is the name of the parameter to remove.

encode

public String encode()

Encode the address as a string and return it.

Specified by:

encode in class GenericObject

Returns:

String canonical encoded version of this address.

encode

public StringBuilder encode(StringBuilder buffer)

Description copied from class: GenericObject

Put the encoded version of this object in the given StringBuilder.

Overrides:

encode in class GenericObject

getAddressType

public int getAddressType()

Get the address type;

Returns:

int

setAddressType

public void setAddressType(int atype)

Set the address type. The address can be NAME_ADDR, ADDR_SPEC or WILD_CARD

Parameters:

atype - int to set

getDisplayName

public String getDisplayName()

get the display name

Specified by:

getDisplayName in interface Address

Returns:

String

setDisplayName

public void setDisplayName(String displayName)

Set the displayName member

Specified by:

setDisplayName in interface Address

Parameters:

displayName - String to set

setAddess

public void setAddess(URI address)

Set the address field

Parameters:

address - SipUri to set

hashCode

public int hashCode()

hashCode impelmentation

Specified by:

hashCode in interface Address

Overrides:

hashCode in class Object

Returns:

a hash code value.

equals

public boolean equals(Object other)

Compare two address specs for equality.

Specified by:

equals in interface Address

Overrides:

equals in class NetObject

Parameters:

other - Object to compare this this address

Returns:

boolean

See Also:

Object

hasDisplayName

public boolean hasDisplayName()

return true if DisplayName exist.

Returns:

boolean

removeDisplayName

public void removeDisplayName()

remove the displayName field

isSIPAddress

public boolean isSIPAddress()

Return true if the imbedded URI is a sip URI.

Returns:

true if the imbedded URI is a SIP URI.

getURI

public URI getURI()

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

Specified by:

getURI in interface Address

Returns:

address parmater of the Address object

isWildcard

public boolean isWildcard()

This determines if this address is a wildcard address. That is Address.getAddress.getUserInfo() == *;

Specified by:

isWildcard in interface Address

Returns:

true if this name address is a wildcard, false otherwise.

setURI

public void setURI(URI address)

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

Specified by:

setURI in interface Address

Parameters:

address - - the new URI address value of this NameAddress.

setUser

public void setUser(String user)

Set the user name for the imbedded URI.

Parameters:

user - -- user name to set for the imbedded URI.

setWildCardFlag

public void setWildCardFlag()

Mark this a wild card address type. Also set the SIP URI to a special wild card address.

clone

public Object clone()

Description copied from class: GenericObject

Clones this object.

Specified by:

clone in interface Address

Overrides:

clone in class GenericObject