org.jacorb.util
Class Time

java.lang.Object
  extended byorg.jacorb.util.Time

public class Time
extends java.lang.Object

Contains static methods to handle CORBA time values.

Version:
$Id: Time.java,v 1.8 2004/05/06 12:40:01 nicolas Exp $
Author:
Andre Spiegel

Field Summary
static long UNIX_OFFSET
          Difference between the CORBA Epoch and the Unix Epoch: the time from 1582/10/15 00:00 until 1970/01/01 00:00 in 100 ns units.
 
Constructor Summary
Time()
           
 
Method Summary
static UtcT corbaFuture(long corbaUnits)
          Returns a CORBA UtcT that represents an instant that lies a given number of CORBA time units (100 ns) in the future.
static UtcT corbaTime()
          Returns the current time as a CORBA UtcT.
static UtcT corbaTime(java.util.Date date)
          Converts the given Java date into a CORBA UtcT.
static UtcT corbaTime(long unixTime)
          Converts the given unixTime into a CORBA UtcT.
static UtcT earliest(UtcT timeA, UtcT timeB)
          Compares two UtcT time values and returns that which is earlier.
static UtcT fromCDR(byte[] buffer)
          Decodes a CDR encapsulation of a UtcT.
static boolean hasPassed(UtcT time)
          Returns true if the instant represented by the given UtcT is already in the past, false otherwise.
static long millisTo(UtcT time)
          Returns the number of milliseconds between now and the given CORBA time.
static byte[] toCDR(UtcT time)
          Returns a CDR encapsulation of the given UtcT.
static void waitFor(UtcT time)
          This method blocks until the given time has been reached.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UNIX_OFFSET

public static final long UNIX_OFFSET
Difference between the CORBA Epoch and the Unix Epoch: the time from 1582/10/15 00:00 until 1970/01/01 00:00 in 100 ns units.

See Also:
Constant Field Values
Constructor Detail

Time

public Time()
Method Detail

corbaTime

public static UtcT corbaTime()
Returns the current time as a CORBA UtcT.


corbaTime

public static UtcT corbaTime(long unixTime)
Converts the given unixTime into a CORBA UtcT.

Parameters:
unixTime - the number of milliseconds since 1970/01/01 00:00 UTC.

corbaTime

public static UtcT corbaTime(java.util.Date date)
Converts the given Java date into a CORBA UtcT.


corbaFuture

public static UtcT corbaFuture(long corbaUnits)
Returns a CORBA UtcT that represents an instant that lies a given number of CORBA time units (100 ns) in the future. If the argument is negative, returns null.


millisTo

public static long millisTo(UtcT time)
Returns the number of milliseconds between now and the given CORBA time. The value is positive if that time is in the future, and negative otherwise.


hasPassed

public static boolean hasPassed(UtcT time)
Returns true if the instant represented by the given UtcT is already in the past, false otherwise. As a special convenience, this method also returns false if the argument is null.


earliest

public static UtcT earliest(UtcT timeA,
                            UtcT timeB)
Compares two UtcT time values and returns that which is earlier. Either argument can be null; this is considered as a time that lies indefinitely in the future. If both arguments are null, this method returns null itself.


toCDR

public static byte[] toCDR(UtcT time)
Returns a CDR encapsulation of the given UtcT.


fromCDR

public static UtcT fromCDR(byte[] buffer)
Decodes a CDR encapsulation of a UtcT.


waitFor

public static void waitFor(UtcT time)
This method blocks until the given time has been reached. If the time is null, or it has already passed, then this method returns immediately.