TimeStamp (MAJ API)

Overview

Package

Class

Tree

Deprecated

Index

Media Authoring
with Java API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

tv.amwa.maj.embeddable
Class TimeStamp

java.lang.Object
  tv.amwa.maj.embeddable.TimeStamp

All Implemented Interfaces:: Serializable, Cloneable, MAJCommon, XMLSerializable, TimeStamp

public final class TimeStamp
extends Object
implements TimeStamp, Serializable, XMLSerializable, Cloneable, MAJCommon
extends Object
implements TimeStamp, Serializable, XMLSerializable, Cloneable, MAJCommon

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

The internal representation of this value is a Calendar value.

A time stamp structure is represented in the database by a column of type date:

     `Date` date

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

Constructor Summary
`TimeStamp()` Create a new time stamp value to represent the time now.
`TimeStamp(Calendar calendarItem)` Create a new time stamp from the given calendar value.
`TimeStamp(DateStruct date, TimeStruct time)` Create a new time stamp from the given date and time structures.

Method Summary
`void`	`appendXMLChildren(Node parent)` Append child elements to the given parent node to serialize the value of an object to an XML fragment.
`static TimeStamp`	`castFromInterface(TimeStamp alien)` Cast a value the implements the `TimeStamp` interface to concrete value of this implementation.
`TimeStamp`	`clone()` Creates a cloned deep copy of this embeddable value.
`boolean`	`equals(Object o)` Checks for the equality of UTC values only and not the exact equality of the underlying calendar value representation.
`DateStruct`	`getDate()` Returns the date component of the time stamp.
`TimeStruct`	`getTime()` Returns the time component of the time stamp.
`Calendar`	`getTimeStamp()` Returns a calendar value representing this time stamp.
`int`	`hashCode()` Returns a hash code value for this embeddable object.
`static TimeStamp`	`parseTimeStamp(String stamp)` Create a time stamp from a string that is formatted according to the UTC standards.
`void`	`setDate(DateStruct date)` Sets the date component of the time stamp.
`void`	`setPropertiesFromInterface(TimeStamp castFrom)` Set the properties of this value from another value that implements that implements the `TimeStamp` interface.
`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.
`void`	`setTimeStamp(Calendar timestampItem)` Set the value of this time stamp using a `Calendar` value.
`String`	`toString()` Formats the string according ISO 8601 and as a UTC value.

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

TimeStamp

public TimeStamp()

Create a new time stamp value to represent the time now.

TimeStamp

public TimeStamp(Calendar calendarItem)
          throws IllegalArgumentException,
                 NullPointerException

Create a new time stamp from the given calendar value.

Parameters:: calendarItem - Calendar value to use to create a new time stamp.
Throws:: IllegalArgumentException - The resulting time stamp value would not be valid.; NullPointerException - Argument is null.

TimeStamp

public TimeStamp(DateStruct date,
                 TimeStruct time)
          throws NullPointerException,
                 IllegalArgumentException

Create a new time stamp from the given date and time structures.

Parameters:: date - Date to set for the new time stamp.; time - Time to set for the new time stamp.
Throws:: NullPointerException - One or more of the arguments is null.; IllegalArgumentException - The resulting time stamp value would not be valid.

Method Detail

castFromInterface

public static final TimeStamp castFromInterface(TimeStamp alien)
                                         throws NullPointerException

Cast a value the implements the TimeStamp interface to concrete value of this implementation.

Parameters:: alien - Value to cast to a concrete instance.
Returns:: Concrete version of the given interface.
Throws:: NullPointerException - Argument is null.

setPropertiesFromInterface

public final void setPropertiesFromInterface(TimeStamp castFrom)
                                      throws NullPointerException

Set the properties of this value from another value that implements that implements the TimeStamp interface.

Parameters:: castFrom - Value to use to set this timecode value.
Throws:: NullPointerException - The given time stamp value is null.