All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.devtools.SIPNoTE.FromEntity

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

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

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


Constructor Index

 o FromEntity()

Method Index

 o fromString(String)
Parses the From: data from a string, and fills in the object.
 o getComment()
Returns the comment portion of the From:.
 o getURL()
Returns the SIP-URL portion of the From:.
 o setComment(String)
Sets the comment portion of the From:.
 o setURL(SIPurl)
Sets the SIP-URL portion of the From:.
 o toFromString()
Constructs a From: string from the data present within the object.

Constructors

 o FromEntity
 public FromEntity()

Methods

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

Parameters:
tostr - String to be converted.
Throws: MalformedHeaderException
Thrown if the From: statement in the string is malformed.
 o toFromString
 public String toFromString() throws MalformedHeaderException
Constructs a From: string from the data present within the object.

Returns:
String representation of the url.
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 From:.

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

Parameters:
newurl - The new URL for the From: header.
 o getComment
 public String getComment()
Returns the comment portion of the From:.

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

Parameters:
comment - The new comment portion of the From: header.

All Packages  Class Hierarchy  This Package  Previous  Next  Index