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

javax.sdp
Interface Time

All Superinterfaces:
Cloneable, Field, Serializable
All Known Implementing Classes:
TimeField

public interface Time
extends Field

A RepeatTime represents a t= field contained within a TimeDescription. A RepeatTime specifies the start and stop times for a SessionDescription. Note: this class uses java.util.Date objects. SDP messages encode time in NTP format. To convert between them use SdpFactory.getDateFromNtp(long) and SdpFactory.getNtpTime(Date). Quoting from RFC 2327: Multiple "t=" fields may be used if a session is active at multiple irregularly spaced times; each additional "t=" field specifies an additional period of time for which the session will be active. If the session is active at regular times, an "r=" field (see below) should be used in addition to and following a "t=" field - in which case the "t=" field specifies the start and stop times of the repeat sequence. Please refer to IETF RFC 2327 for a description of SDP.

Version:
1.0
Author:
deruelle

Method Summary
 Date getStart()
          Returns the start time of the conference/session.
 Date getStop()
          Returns the stop time of the session
 boolean getTypedTime()
          Returns whether the field will be output as a typed time or a integer value.
 boolean isZero()
          Returns whether the start and stop times were set to zero (in NTP).
 void setStart(Date start)
          Sets the start time of the conference/session.
 void setStop(Date stop)
          Sets the stop time of the session.
 void setTypedTime(boolean typedTime)
          Sets whether the field will be output as a typed time or a integer value.
 void setZero()
          Sets the start and stop times to zero (in NTP).
 
Methods inherited from interface javax.sdp.Field
clone, getTypeChar
 

Method Detail

getStart

Date getStart()
              throws SdpParseException
Returns the start time of the conference/session.

Returns:
the date
Throws:
SdpParseException

setStart

void setStart(Date start)
              throws SdpException
Sets the start time of the conference/session.

Parameters:
start - start - the start time for the session.
Throws:
SdpException - if the date is null

getStop

Date getStop()
             throws SdpParseException
Returns the stop time of the session

Returns:
the stop time of the session.
Throws:
SdpParseException

setStop

void setStop(Date stop)
             throws SdpException
Sets the stop time of the session.

Parameters:
stop - start - the start time
Throws:
SdpException - if the date is null

isZero

boolean isZero()
Returns whether the start and stop times were set to zero (in NTP).

Returns:
boolean

setZero

void setZero()
Sets the start and stop times to zero (in NTP).


getTypedTime

boolean getTypedTime()
Returns whether the field will be output as a typed time or a integer value. Typed time is formatted as an integer followed by a unit character. The unit indicates an appropriate multiplier for the integer. The following unit types are allowed. d - days (86400 seconds) h - hours (3600 seconds) m - minutes (60 seconds) s - seconds ( 1 seconds)

Returns:
true, if the field will be output as a typed time; false, if as an integer value.

setTypedTime

void setTypedTime(boolean typedTime)
Sets whether the field will be output as a typed time or a integer value. Typed time is formatted as an integer followed by a unit character. The unit indicates an appropriate multiplier for the integer. The following unit types are allowed. d - days (86400 seconds) h - hours (3600 seconds) m - minutes (60 seconds) s - seconds ( 1 seconds)

Parameters:
typedTime - typedTime - if set true, the start and stop times will be output in an optimal typed time format; if false, the times will be output as integers.

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.