org.csstudio.data.values.internal

Class Timestamp

java.lang.Object

org.csstudio.data.values.internal.Timestamp

All Implemented Interfaces:

Comparable<ITimestamp>, ITimestamp

public final class Timestamp
extends Object
implements ITimestamp

Implementation of the ITimestamp interface.

Author:

Sven Wende, Kay Kasemir

Nested Class Summary

Nested classes/interfaces inherited from interface org.csstudio.data.values.ITimestamp

ITimestamp.Format

Field Summary

Fields

Modifier and Type	Field and Description
static long	MILLIS_PER_SECOND Milliseconds per second.
static long	NANOS_PER_MILLI Nanoseconds per millisecond.
static long	NANOS_PER_SECOND Nanoseconds per second.

Constructor Summary

Constructors

Constructor and Description
Timestamp(double seconds) Constructor with fractional seconds since epoch.
Timestamp(long seconds, long nanoseconds) Constructor with seconds and nanoseconds since epoch.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ITimestamp rhs)
boolean	equals(Object obj)
String	format(ITimestamp.Format format) Format time according to the given format.
int	hashCode()
boolean	isGreaterOrEqual(ITimestamp other)
boolean	isGreaterThan(ITimestamp other)
boolean	isLessOrEqual(ITimestamp other)
boolean	isLessThan(ITimestamp other)
boolean	isValid()
long	nanoseconds() Nanoseconds within seconds.
long	seconds() Get seconds since epoch, i.e.
Calendar	toCalendar() Convert to Calendar.
double	toDouble() Convert to double.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MILLIS_PER_SECOND

public static final long MILLIS_PER_SECOND

Milliseconds per second.

See Also:

Constant Field Values

NANOS_PER_MILLI

public static final long NANOS_PER_MILLI

Nanoseconds per millisecond.

See Also:

Constant Field Values

NANOS_PER_SECOND

public static final long NANOS_PER_SECOND

Nanoseconds per second.

See Also:

Constant Field Values

Constructor Detail

Timestamp

public Timestamp(long seconds,
                 long nanoseconds)

Constructor with seconds and nanoseconds since epoch.

Parameters:

seconds - Seconds since epoch

nanoseconds - Nanoseconds within seconds

Timestamp

public Timestamp(double seconds)

Constructor with fractional seconds since epoch.

Parameters:

seconds - Seconds since epoch

Method Detail

seconds

public long seconds()

Description copied from interface: ITimestamp

Get seconds since epoch, i.e. 1 January 1970 0:00 UTC.

Note that we always return seconds relative to this UTC epoch, even if the original control system data source might use a different epoch (example: EPICS uses 1990), because the 1970 epoch is most compatible with existing programming environments.

Specified by:

seconds in interface ITimestamp

Returns:

Seconds since 1970.

nanoseconds

public long nanoseconds()

Description copied from interface: ITimestamp

Nanoseconds within seconds.

Specified by:

nanoseconds in interface ITimestamp

Returns:

The nanoseconds, 0...999999999.

See Also:

ITimestamp.seconds()

isValid

public boolean isValid()

Specified by:

isValid in interface ITimestamp

Returns:

Returns true if seconds and nanoseconds are > 0.

toDouble

public double toDouble()

Description copied from interface: ITimestamp

Convert to double.

Specified by:

toDouble in interface ITimestamp

Returns:

Return seconds and fractional nanoseconds.

toCalendar

public Calendar toCalendar()

Description copied from interface: ITimestamp

Convert to Calendar.

Specified by:

toCalendar in interface ITimestamp

Returns:

Calendar version of this time stamp down to millisecond detail.

format

public String format(ITimestamp.Format format)

Description copied from interface: ITimestamp

Format time according to the given format.

Specified by:

format in interface ITimestamp

Parameters:

format - format to use

Returns:

The formatted time.

toString

public String toString()

Overrides:

toString in class Object

isGreaterThan

public boolean isGreaterThan(ITimestamp other)

Specified by:

isGreaterThan in interface ITimestamp

Parameters:

other - Other time stamp

Returns:

Returns true if this time stamp is greater than the other time stamp.

isGreaterOrEqual

public boolean isGreaterOrEqual(ITimestamp other)

Specified by:

isGreaterOrEqual in interface ITimestamp

Parameters:

other - Other time stamp

Returns:

Returns true if this time stamp is greater than or equal to the other time stamp.

isLessThan

public boolean isLessThan(ITimestamp other)

Specified by:

isLessThan in interface ITimestamp

Parameters:

other - Other time stamp

Returns:

Returns true if this time stamp is smaller than the other time stamp.

isLessOrEqual

public boolean isLessOrEqual(ITimestamp other)

Specified by:

isLessOrEqual in interface ITimestamp

Parameters:

other - Other time stamp

Returns:

Returns true if this time stamp is smaller than or equal to the other time stamp.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(ITimestamp rhs)

Specified by:

compareTo in interface Comparable<ITimestamp>