gov.nist.javax.sip.header
Class To

java.lang.Object
  gov.nist.core.GenericObject
      gov.nist.javax.sip.header.SIPObject
          gov.nist.javax.sip.header.SIPHeader
              gov.nist.javax.sip.header.ParametersHeader
                  gov.nist.javax.sip.header.AddressParametersHeader
                      gov.nist.javax.sip.header.To

All Implemented Interfaces:

Cloneable, Header, HeaderAddress, Parameters, Serializable, SIPHeaderNames, ToHeader

public final class To

extends AddressParametersHeader

implements ToHeader

To SIP Header.

Version:

JAIN-SIP-1.1

Author:

M. Ranganathan
, Olivier Deruelle
This code is in the public domain.

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.sip.header.ToHeader

NAME

Fields inherited from interface gov.nist.javax.sip.header.SIPHeaderNames

ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ALERT_INFO, ALLOW, ALLOW_EVENTS, AUTHENTICATION_INFO, AUTHORIZATION, CALL_ID, CALL_INFO, CONTACT, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CSEQ, DATE, ERROR_INFO, EVENT, EXPIRES, FROM, IN_REPLY_TO, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE

Constructor Summary

To()
default Constructor.

To(From from)
Generate a TO header from a FROM header

Method Summary

String	encode() Encode the header into a String.
boolean	equals(Object otherHeader) Compare two To headers for equality.
String	getDisplayName() Get the display name from the address.
HostPort	getHostPort() Conveniance accessor function to get the hostPort field from the address.
String	getTag() Get the tag parameter from the address parm list.
String	getUserAtHostPort() Get the user@host port string.
boolean	hasTag() Boolean function
void	removeTag() remove Tag member
void	setTag(String t) Set the tag member.
String	toString() Gets a string representation of the Header.

Methods inherited from class gov.nist.javax.sip.header.AddressParametersHeader

getAddress, setAddress

Methods inherited from class gov.nist.javax.sip.header.ParametersHeader

getNameValue, getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, setParameter, setParameter, setParameters, setQuotedParameter

Methods inherited from class gov.nist.javax.sip.header.SIPHeader

getHeaderName, getHeaderValue, getName, getValue, isHeaderList, setHeaderName

Methods inherited from class gov.nist.javax.sip.header.SIPObject

clone, dbgPrint, debugDump, debugDump, match, merge, replace, replace, replace, replace

Methods inherited from class gov.nist.core.GenericObject

getClassFromName, getMatcher, isMySubclass, match, setMatcher

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.sip.header.HeaderAddress

getAddress, setAddress

Methods inherited from interface javax.sip.header.Parameters

getParameter, getParameterNames, removeParameter, setParameter

Methods inherited from interface javax.sip.header.Header

clone, getName

Constructor Detail

To

public To()

default Constructor.

To

public To(From from)

Generate a TO header from a FROM header

Method Detail

equals

public boolean equals(Object otherHeader)

Compare two To headers for equality.

Specified by:

equals in interface Header

Overrides:

equals in class SIPObject

Parameters:

otherHeader - Object to set

Returns:

true if the two headers are the same.

encode

public String encode()

Encode the header into a String.

Overrides:

encode in class SIPHeader

Returns:

String

Since:

1.0

getHostPort

public HostPort getHostPort()

Conveniance accessor function to get the hostPort field from the address. Warning -- this assumes that the embedded URI is a SipURL.

Returns:

hostport field

getDisplayName

public String getDisplayName()

Get the display name from the address.

Returns:

Display name

getTag

public String getTag()

Get the tag parameter from the address parm list.

Specified by:

getTag in interface ToHeader

Returns:

tag field

hasTag

public boolean hasTag()

Boolean function

Returns:

true if the Tag exist

removeTag

public void removeTag()

remove Tag member

setTag

public void setTag(String t)
            throws ParseException

Set the tag member. This should be set to null for the initial request in a dialog.

Specified by:

setTag in interface ToHeader

Parameters:

t - tag String to set.

Throws:

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

getUserAtHostPort

public String getUserAtHostPort()

Get the user@host port string.

toString

public String toString()

Gets a string representation of the Header. This method overrides the toString method in java.lang.Object.

Specified by:

toString in interface Header

Overrides:

toString in class SIPObject

Returns:

string representation of Header