Media Authoring
with Java API

tv.amwa.maj.record
Interface TimeStamp

All Known Implementing Classes:
TimeStamp

public interface TimeStamp

Specifies a date and time in UTC (Coordinated Universal Time). The value is made up of a date and time structure.

For more information on UTC, see the entry on Coordinated Universal Time on Wikipedia.

Author:
Richard Cartwright
See Also:
TimeStruct, DateStruct, TypeDefinitionRecord.TimeStamp

Method Summary
 DateStruct getDate()
          Returns the date component of the time stamp.
 TimeStruct getTime()
          Returns the time component of the time stamp.
 void setDate(DateStruct date)
          Sets the date component of the time stamp.
 void setStamp(DateStruct date, TimeStruct time)
          Simultaneously sets the date and time components of the time stamp.
 void setTime(TimeStruct time)
          Sets the time component of the time stamp.
 

Method Detail

setStamp

void setStamp(DateStruct date,
              TimeStruct time)
              throws NullPointerException,
                     IllegalArgumentException

Simultaneously sets the date and time components of the time stamp.

Parameters:
date - Date component of the time stamp.
time - Time component of the time stamp.
Throws:
NullPointerException - One or both of the given data or time structures are null.
IllegalArgumentException - One or both of the given date or time values are not valid.

getDate

DateStruct getDate()

Returns the date component of the time stamp.

Returns:
Date component of the time stamp.

setDate

void setDate(DateStruct date)
             throws NullPointerException,
                    IllegalArgumentException

Sets the date component of the time stamp.

Parameters:
date - Date component of the time stamp.
Throws:
NullPointerException - The given data structure is null.
IllegalArgumentException - The given date is not valid.

getTime

TimeStruct getTime()

Returns the time component of the time stamp.

Returns:
Time component of the time stamp.

setTime

void setTime(TimeStruct time)
             throws NullPointerException,
                    IllegalArgumentException

Sets the time component of the time stamp.

Parameters:
time - Time component of the time stamp.
Throws:
NullPointerException - The given time structure is null.
IllegalArgumentException - The given time is not valid.

Media Authoring
with Java API

(c) 2007-2008 Richard Cartwright, all rights reserved. Subject to the terms of the AAF SDK Public Source License.