All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.devtools.SIPNoTE.ToEntity

java.lang.Object
   |
   +----com.ibm.devtools.SIPNoTE.ToEntity

public class ToEntity
extends Object
This class represents the data contained in the To: header field of a SIP message.

For example:
     To: nagy@watson.ibm.com (Bill Nagy)
 


Constructor Index

 o ToEntity()

Method Index

 o fromString(String)
Parses the To: data from a string, and fills in the object.
 o getComment()
Returns the comment portion of the To:.
 o getURL()
Returns the SIP-URL portion of the To:.
 o setComment(String)
Sets the comment portion of the To:.
 o setURL(SIPurl)
Sets the SIP-URL portion of the To:.
 o toToString()
Constructs a To: string from the data present within the object.
 o toToStringWithoutHeader()
Constructs a To: string from the data present within the object, but leaves off the 'To:'.

Constructors

 o ToEntity
 public ToEntity()

Methods

 o fromString
 public void fromString(String tostr) throws MalformedHeaderException
Parses the To: data from a string, and fills in the object.

Parameters:
tostr - The string to parse.
Throws: MalformedHeaderException
Thrown if the To: statement in the string is malformed.
 o toToStringWithoutHeader
 public String toToStringWithoutHeader() throws MalformedHeaderException
Constructs a To: string from the data present within the object, but leaves off the 'To:'.

Returns:
The string representing the To: field.
Throws: MalformedHeaderException
Thrown if enough data is not present within the object to build the string.
 o toToString
 public String toToString() throws MalformedHeaderException
Constructs a To: string from the data present within the object.

Returns:
The string representing the To: field.
Throws: MalformedHeaderException
Thrown if enough data is not present within the object to build the string.
 o getURL
 public SIPurl getURL()
Returns the SIP-URL portion of the To:.

Returns:
A SIP URL
 o setURL
 public void setURL(SIPurl newurl)
Sets the SIP-URL portion of the To:.

Parameters:
newurl - The new SIP URL.
 o getComment
 public String getComment()
Returns the comment portion of the To:.

Returns:
The comment.
 o setComment
 public void setComment(String comment)
Sets the comment portion of the To:.

Parameters:
comment - The new comment.

All Packages  Class Hierarchy  This Package  Previous  Next  Index