NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

gov.nist.javax.sip.header
Class TimeStamp

java.lang.Object
  extended by gov.nist.core.GenericObject
      extended by gov.nist.javax.sip.header.SIPObject
          extended by gov.nist.javax.sip.header.SIPHeader
              extended by gov.nist.javax.sip.header.TimeStamp
All Implemented Interfaces:
HeaderExt, SIPHeaderNames, Serializable, Cloneable, Header, TimeStampHeader

public class TimeStamp
extends SIPHeader
implements TimeStampHeader

TimeStamp SIP Header.

Version:
1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:39 $
Author:
M. Ranganathan
, Olivier Deruelle
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface javax.sip.header.TimeStampHeader
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, JOIN, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, MIN_SE, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REFERRED_BY, REPLACES, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SESSION_EXPIRES, SIP_ETAG, SIP_IF_MATCH, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE
 
Constructor Summary
TimeStamp()
          Default Constructor
 
Method Summary
 String encodeBody()
          Return canonical form of the header.
 float getDelay()
          Gets delay of TimeStampHeader.
 long getTime()
          Gets the timestamp value of this TimeStampHeader.
 int getTimeDelay()
          Gets delay of TimeStampHeader.
 float getTimeStamp()
          Gets the timestamp value of this TimeStampHeader.
 boolean hasDelay()
          return true if delay exists
 void removeDelay()
           
 void setDelay(float delay)
          Sets the new delay value of the TimestampHeader to the delay paramter passed to this method
 void setTime(long timeStamp)
          Sets the timestamp value of this TimeStampHeader to the new timestamp value passed to this method.
 void setTimeDelay(int delay)
          Sets the new delay value of the TimestampHeader to the delay parameter passed to this method
 void setTimeStamp(float timeStamp)
          Sets the timestamp value of this TimeStampHeader to the new timestamp value passed to this method.
 
Methods inherited from class gov.nist.javax.sip.header.SIPHeader
encode, encode, getHeaderName, getHeaderValue, getName, getValue, hashCode, isHeaderList, setHeaderName, toString
 
Methods inherited from class gov.nist.javax.sip.header.SIPObject
dbgPrint, debugDump, debugDump, equals, match
 
Methods inherited from class gov.nist.core.GenericObject
clone, getClassFromName, getMatcher, isMySubclass, makeClone, merge, setMatcher
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.sip.header.Header
clone, equals, getName, hashCode, toString
 

Constructor Detail

TimeStamp

public TimeStamp()
Default Constructor

Method Detail

encodeBody

public String encodeBody()
Return canonical form of the header.

Returns:
String

hasDelay

public boolean hasDelay()
return true if delay exists

Returns:
boolean

removeDelay

public void removeDelay()

setTimeStamp

public void setTimeStamp(float timeStamp)
                  throws InvalidArgumentException
Description copied from interface: TimeStampHeader
Sets the timestamp value of this TimeStampHeader to the new timestamp value passed to this method.

Specified by:
setTimeStamp in interface TimeStampHeader
Parameters:
timeStamp - - the new float timestamp value
Throws:
InvalidArgumentException - if the timestamp value argument is a negative value.

getTimeStamp

public float getTimeStamp()
Description copied from interface: TimeStampHeader
Gets the timestamp value of this TimeStampHeader.

Specified by:
getTimeStamp in interface TimeStampHeader
Returns:
the timestamp value of this TimeStampHeader

getDelay

public float getDelay()
Description copied from interface: TimeStampHeader
Gets delay of TimeStampHeader. This method returns -1 if the delay parameter is not set.

Specified by:
getDelay in interface TimeStampHeader
Returns:
the delay value of this TimeStampHeader

setDelay

public void setDelay(float delay)
              throws InvalidArgumentException
Sets the new delay value of the TimestampHeader to the delay paramter passed to this method

Specified by:
setDelay in interface TimeStampHeader
Parameters:
delay - - the new float delay value
Throws:
InvalidArgumentException - if the delay value argumenmt is a negative value other than -1.

getTime

public long getTime()
Description copied from interface: TimeStampHeader
Gets the timestamp value of this TimeStampHeader.

Specified by:
getTime in interface TimeStampHeader
Returns:
the timestamp value of this TimeStampHeader

getTimeDelay

public int getTimeDelay()
Description copied from interface: TimeStampHeader
Gets delay of TimeStampHeader. This method returns -1 if the delay parameter is not set.

Specified by:
getTimeDelay in interface TimeStampHeader
Returns:
the delay value of this TimeStampHeader as an integer.

setTime

public void setTime(long timeStamp)
             throws InvalidArgumentException
Description copied from interface: TimeStampHeader
Sets the timestamp value of this TimeStampHeader to the new timestamp value passed to this method. This method allows applications to conveniantly use System.currentTimeMillis to set the timeStamp value.

Specified by:
setTime in interface TimeStampHeader
Parameters:
timeStamp - - the new long timestamp value
Throws:
InvalidArgumentException - if the timestamp value argument is a negative value.

setTimeDelay

public void setTimeDelay(int delay)
                  throws InvalidArgumentException
Description copied from interface: TimeStampHeader
Sets the new delay value of the TimestampHeader to the delay parameter passed to this method

Specified by:
setTimeDelay in interface TimeStampHeader
Parameters:
delay - - the new int delay value
Throws:
InvalidArgumentException - if the delay value argumenmt is a negative value other than the default value -1.

NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Submit a bug report or feature request.