    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)

##

FromEntity()

##

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

##

FromEntity

     public FromEntity()

##

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.

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.

getURL

     public SIPurl getURL()

  Returns the SIP-URL portion of the From:.

  Returns:
    SIP URL

setURL

     public void setURL(SIPurl newurl)

  Sets the SIP-URL portion of the From:.

  Parameters:
    newurl - The new URL for the From: header.

getComment

     public String getComment()

  Returns the comment portion of the From:.

  Returns:
    The comment portion of the From: header.

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