    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)

##

ToEntity()

##

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

##

ToEntity

     public ToEntity()

##

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.

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.

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.

getURL

     public SIPurl getURL()

  Returns the SIP-URL portion of the To:.

  Returns:
    A SIP URL

setURL

     public void setURL(SIPurl newurl)

  Sets the SIP-URL portion of the To:.

  Parameters:
    newurl - The new SIP URL.

getComment

     public String getComment()

  Returns the comment portion of the To:.

  Returns:
    The comment.

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