TimeStruct (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 TimeStruct

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

All Implemented Interfaces:: Serializable, Cloneable, MAJCommon, TimeStruct

public final class TimeStruct
extends Object
implements TimeStruct, Serializable, Cloneable, MAJCommon
extends Object
implements TimeStruct, Serializable, Cloneable, MAJCommon

Implementation of the time component of date and time values specified according to Coordinated Universal Time (UTC), including hour, minute, second and 1/100th of a second. The time structure is itself a component of a timestamp.

This implementation is backed by a Calendar.

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

Constructor Summary
`TimeStruct()` Create a new time structure set to the current time.
`TimeStruct(byte hour, byte minute, byte second)` Create a time value from its hour, minute and second component parts.
`TimeStruct(byte hour, byte minute, byte second, byte fraction)` Create a time value from all of its component parts.
`TimeStruct(Calendar timeItem)` Create a new time structure from the given calendar value.

Method Summary
`static TimeStruct`	`castFromInterface(TimeStruct alien)` Cast a value the implements the `TimeStruct` interface to concrete value of this implementation.
`TimeStruct`	`clone()` Creates a cloned deep copy of this embeddable value.
`boolean`	`equals(Object o)` Tests to see if the value of two time structures are equal.
`byte`	`getFraction()` Returns the fractions of a second component of the time value.
`byte`	`getHour()` Returns the hours component of the time value.
`byte`	`getMinute()` Returns the minutes component of the time value.
`byte`	`getSecond()` Returns the seconds component of the time value.
`Calendar`	`getTimeValue()` Returns a copy of the calendar value used to represent the time value.
`int`	`hashCode()` Returns a hash code value for this embeddable object.
`static TimeStruct`	`parseTimeStruct(String time)` Creates a new time value from a UTC-style string.
`void`	`setFraction(byte fraction)` Sets the fractions of a second component of the time value, in the range 0 to 99.
`void`	`setHour(byte hour)` Sets the hours component of the time value, in the range 0 to 23.
`void`	`setMinute(byte minute)` Sets the minutes component of the time value, in the range 0 to 59.
`void`	`setPropertiesFromInterface(TimeStruct castFrom)` Set the properties of this value from those available in the given value, which is specified by the time structure interface.
`void`	`setSecond(byte second)` Sets the second component of the time value, normally in the range 0 to 59.
`void`	`setTime(byte hour, byte minute, byte second)` Set the values of the time structure using an hour, minute and second values provided.
`void`	`setTime(byte hour, byte minute, byte second, byte fraction)` Sets all the values of the time structure using the hour, minute, second and fraction of a second values provided.
`void`	`setTimeValue(Calendar timeItem)` Sets the value of the time structure from the given calendar value.
`String`	`toString()` Creates a UTC-style string representation of the time structure's value, including the timezone offset.

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

Constructor Detail

TimeStruct

public TimeStruct(byte hour,
                  byte minute,
                  byte second,
                  byte fraction)
           throws IllegalArgumentException

Create a time value from all of its component parts.

Parameters:: hour - Hour component of the time value, in the inclusive range 0 to 23.; minute - Minute component of the time value, in the inclusive range 0 to 59.; second - Second component of the time value, normally in the inclusive range 0 to 59.; fraction - 1/100th of a second component of the time value, in the inclusive range 0 to 99.
Throws:: IllegalArgumentException - One or more of the parameters is out of range.

TimeStruct

public TimeStruct(byte hour,
                  byte minute,
                  byte second)
           throws IllegalArgumentException

Create a time value from its hour, minute and second component parts. The fraction of a second is set to 0.

Parameters:: hour - Hour component of the time value, in the inclusive range 0 to 23.; minute - Minute component of the time value, in the inclusive range 0 to 59.; second - Second component of the time value, normally in the inclusive range 0 to 59.
Throws:: IllegalArgumentException - One or more of the parameters is out of range.

TimeStruct

public TimeStruct(Calendar timeItem)
           throws NullPointerException,
                  IllegalArgumentException

Create a new time structure from the given calendar value.

Parameters:: timeItem - Calendar item to use to create a new time structure.
Throws:: NullPointerException - Argument is null.; IllegalArgumentException - The given calendar value contains out-of-range values.

TimeStruct

public TimeStruct()

Create a new time structure set to the current time.

Method Detail

castFromInterface

public static final TimeStruct castFromInterface(TimeStruct alien)
                                          throws NullPointerException

Cast a value the implements the TimeStruct 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 - The alien value argument is null.
See Also:: setPropertiesFromInterface(tv.amwa.maj.record.TimeStruct)

setPropertiesFromInterface

public final void setPropertiesFromInterface(TimeStruct castFrom)
                                      throws NullPointerException

Set the properties of this value from those available in the given value, which is specified by the time structure interface.

Parameters:: castFrom - Value to extract properties from.
Throws:: NullPointerException - The given value to use to set this value is null.
See Also:: castFromInterface(tv.amwa.maj.record.TimeStruct)