com.amx.duet.tools.util
Class TimeDateUtil

java.lang.Object
  extended bycom.amx.duet.tools.util.TimeDateUtil

public class TimeDateUtil
extends java.lang.Object

A utility class, which contains a variety of Time and Date manipulation routines.

Since:
AMXTools 1.0.0
Version:
1.0.1

Field Summary
static java.lang.String DATE_FORMAT
           
static long ONE_DAY
           
static int ONE_HOUR
           
static int ONE_MINUTE
           
static int ONE_SECOND
           
static long ONE_WEEK
           
static int TDL_DATE_LEN
           
static int TDL_DAYS_PER_YEAR
           
static int TDL_FRIDAY
           
static int TDL_HOURS_PER_DAY
           
static int TDL_MINUTES_PER_DAY
           
static int TDL_MINUTES_PER_HOUR
           
static int TDL_MONDAY
           
static int TDL_MONTHS_PER_YEAR
           
static int TDL_SATURDAY
           
static int TDL_SECONDS_PER_DAY
           
static int TDL_SECONDS_PER_HOUR
           
static int TDL_SECONDS_PER_MINUTE
           
static int TDL_SUNDAY
           
static int TDL_THURSDAY
           
static int TDL_TIME_LEN
           
static int TDL_TUESDAY
           
static int TDL_WEDNESDAY
           
static java.lang.String TIME_DATE_FORMAT
           
static java.lang.String TIME_FORMAT
           
 
Constructor Summary
TimeDateUtil()
           
 
Method Summary
static java.lang.String AmPmTime(java.lang.String sTime)
           
static java.lang.String CalcFloatingDate(int nDayOfMonthOffset, int nDayOfMonthDay, int nMonth, int nYear)
           
static java.lang.String CurrentDate()
           
static java.lang.String CurrentTime()
           
static java.lang.String DateAdd(java.lang.String sDate, long lDay, long lMonth, long lYear)
           
static int DateCompare(java.lang.String sDate1, java.lang.String sDate2)
           
static int DateDiff(java.lang.String sDate1, java.lang.String sDate2, ObjectRef rDay, ObjectRef rMonth, ObjectRef rYear)
           
static java.lang.String DateSerial(long lMonth, long lDay, long lYear, int nYrLen, boolean bUKDate)
           
static java.util.Date DateStringToDate(java.lang.String sDate)
          Converts a preformatted date string to a date object
static long DateToDay(java.lang.String sDate)
           
static long DateToMonth(java.lang.String sDate)
           
static java.lang.String DateToString(java.util.Date date, java.lang.String pattern)
          Converts a date object to a string
static java.lang.String DateToStringDate(java.util.Date date)
          Converts a date object to a preformatted date string
static java.lang.String DateToStringTime(java.util.Date date)
          Converts a date object to a preformatted time string
static long DateToYear(java.lang.String sDate)
           
static int DaysPerMonth(long lMonth, long lYear)
           
static java.lang.String FormatDate(int nMonth, int nDay, int nYear)
          Formats the integer values of a date to a preformatted date string
static java.lang.String FormatDate(int nMonth, int nDay, int nYear, java.lang.String sPattern)
           
static java.lang.String FormatTime(int nHour, int nMin, int nSec)
          Formats the integer values of a time to a preformatted time string
static java.lang.String GetFormalDate(java.lang.String sDate, boolean bUKDate)
           
static java.lang.String GetFormalDateDay(long lDay)
           
static java.lang.String GetFormalDayOffset(long lOffset)
           
static long getNextTimeout(long timeout)
          Adds the specified number of milliseconds to the current time and returns the added value
static boolean isTimeExpired(long timeout)
          Checks to see if the current time is greater than the specified time in milliseconds
static java.lang.String LocalizedDate(java.lang.String sDate, boolean bUKDate)
           
static java.lang.String LocalizedTime(java.lang.String sTime, boolean bMilitary)
           
static java.lang.String LongDayName(java.util.Date date)
          Retrieves the long name of a day from a Date object
static java.lang.String LongMonthName(java.util.Date date)
          Retrieves the long name of a month from a Date object
static long nanoTime()
          Convert the current system time to nano seconds for applications that require it.
static java.lang.String ShortAmPmTime(java.lang.String sTime)
           
static java.lang.String ShortDayName(java.util.Date date)
          Retrieves the short name of a day from a Date object
static java.lang.String ShortLocalizedTime(java.lang.String sTime, boolean bMilitary)
           
static java.lang.String ShortMonthName(java.util.Date date)
          Retrieves the short name of a month from a Date object
static java.util.Date StringToDate(java.lang.String str, java.lang.String pattern)
          Converts a string to a date object
static java.lang.String TimeAdd(java.lang.String sTime, long lSec, long lMin, long lHour)
           
static long TimeDateDiff(java.lang.String sTimeDate1, java.lang.String sTimeDate2, int nTimeField, ObjectRef rbOneLtTwo)
          Gets the select difference between two time values
static java.lang.String TimeDiff(java.lang.String sTime1, java.lang.String sTime2, ObjectRef rlSec, ObjectRef rlMin, ObjectRef rlHour, ObjectRef rbOneLtTwo)
           
static java.lang.String TimeSerial(long lHour, long lMin, long lSec)
           
static java.util.Date TimeStringToDate(java.lang.String sTime)
          Converts a preformatted time string to a date object
static long TimeToHour(java.lang.String sTime)
           
static long TimeToMinute(java.lang.String sTime)
           
static long TimeToSecond(java.lang.String sTime)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TIME_FORMAT

public static final java.lang.String TIME_FORMAT
See Also:
Constant Field Values

DATE_FORMAT

public static final java.lang.String DATE_FORMAT
See Also:
Constant Field Values

TIME_DATE_FORMAT

public static final java.lang.String TIME_DATE_FORMAT
See Also:
Constant Field Values

TDL_DATE_LEN

public static final int TDL_DATE_LEN
See Also:
Constant Field Values

TDL_TIME_LEN

public static final int TDL_TIME_LEN
See Also:
Constant Field Values

TDL_SUNDAY

public static final int TDL_SUNDAY
See Also:
Constant Field Values

TDL_MONDAY

public static final int TDL_MONDAY
See Also:
Constant Field Values

TDL_TUESDAY

public static final int TDL_TUESDAY
See Also:
Constant Field Values

TDL_WEDNESDAY

public static final int TDL_WEDNESDAY
See Also:
Constant Field Values

TDL_THURSDAY

public static final int TDL_THURSDAY
See Also:
Constant Field Values

TDL_FRIDAY

public static final int TDL_FRIDAY
See Also:
Constant Field Values

TDL_SATURDAY

public static final int TDL_SATURDAY
See Also:
Constant Field Values

TDL_SECONDS_PER_MINUTE

public static final int TDL_SECONDS_PER_MINUTE
See Also:
Constant Field Values

TDL_MINUTES_PER_HOUR

public static final int TDL_MINUTES_PER_HOUR
See Also:
Constant Field Values

TDL_HOURS_PER_DAY

public static final int TDL_HOURS_PER_DAY
See Also:
Constant Field Values

TDL_SECONDS_PER_HOUR

public static final int TDL_SECONDS_PER_HOUR
See Also:
Constant Field Values

TDL_MINUTES_PER_DAY

public static final int TDL_MINUTES_PER_DAY
See Also:
Constant Field Values

TDL_SECONDS_PER_DAY

public static final int TDL_SECONDS_PER_DAY
See Also:
Constant Field Values

TDL_MONTHS_PER_YEAR

public static final int TDL_MONTHS_PER_YEAR
See Also:
Constant Field Values

TDL_DAYS_PER_YEAR

public static final int TDL_DAYS_PER_YEAR
See Also:
Constant Field Values

ONE_SECOND

public static final int ONE_SECOND
See Also:
Constant Field Values

ONE_MINUTE

public static final int ONE_MINUTE
See Also:
Constant Field Values

ONE_HOUR

public static final int ONE_HOUR
See Also:
Constant Field Values

ONE_DAY

public static final long ONE_DAY
See Also:
Constant Field Values

ONE_WEEK

public static final long ONE_WEEK
See Also:
Constant Field Values
Constructor Detail

TimeDateUtil

public TimeDateUtil()
Method Detail

nanoTime

public static final long nanoTime()
Convert the current system time to nano seconds for applications that require it.

Returns:
a long value containing the converted time.

LongDayName

public static final java.lang.String LongDayName(java.util.Date date)
Retrieves the long name of a day from a Date object

Parameters:
date - a Date object
Returns:
The long name of a Day (ie. Wednesday)

ShortDayName

public static final java.lang.String ShortDayName(java.util.Date date)
Retrieves the short name of a day from a Date object

Parameters:
date - a Date object
Returns:
The short name of a Day (ie. Wed)

LongMonthName

public static final java.lang.String LongMonthName(java.util.Date date)
Retrieves the long name of a month from a Date object

Parameters:
date - a Date object
Returns:
The long name of a Month (ie. January)

ShortMonthName

public static final java.lang.String ShortMonthName(java.util.Date date)
Retrieves the short name of a month from a Date object

Parameters:
date - a Date object
Returns:
The short name of a Month (ie. Jan)

GetFormalDateDay

public static final java.lang.String GetFormalDateDay(long lDay)

GetFormalDayOffset

public static final java.lang.String GetFormalDayOffset(long lOffset)

GetFormalDate

public static final java.lang.String GetFormalDate(java.lang.String sDate,
                                                   boolean bUKDate)
                                            throws java.text.ParseException
Throws:
java.text.ParseException

DaysPerMonth

public static final int DaysPerMonth(long lMonth,
                                     long lYear)

TimeSerial

public static final java.lang.String TimeSerial(long lHour,
                                                long lMin,
                                                long lSec)

DateSerial

public static final java.lang.String DateSerial(long lMonth,
                                                long lDay,
                                                long lYear,
                                                int nYrLen,
                                                boolean bUKDate)

LocalizedDate

public static final java.lang.String LocalizedDate(java.lang.String sDate,
                                                   boolean bUKDate)

TimeAdd

public static final java.lang.String TimeAdd(java.lang.String sTime,
                                             long lSec,
                                             long lMin,
                                             long lHour)

TimeDiff

public static final java.lang.String TimeDiff(java.lang.String sTime1,
                                              java.lang.String sTime2,
                                              ObjectRef rlSec,
                                              ObjectRef rlMin,
                                              ObjectRef rlHour,
                                              ObjectRef rbOneLtTwo)
                                       throws java.text.ParseException
Throws:
java.text.ParseException

DateDiff

public static final int DateDiff(java.lang.String sDate1,
                                 java.lang.String sDate2,
                                 ObjectRef rDay,
                                 ObjectRef rMonth,
                                 ObjectRef rYear)

DateAdd

public static final java.lang.String DateAdd(java.lang.String sDate,
                                             long lDay,
                                             long lMonth,
                                             long lYear)

DateCompare

public static final int DateCompare(java.lang.String sDate1,
                                    java.lang.String sDate2)
                             throws java.text.ParseException
Throws:
java.text.ParseException

AmPmTime

public static final java.lang.String AmPmTime(java.lang.String sTime)
                                       throws java.text.ParseException
Throws:
java.text.ParseException

ShortAmPmTime

public static final java.lang.String ShortAmPmTime(java.lang.String sTime)
                                            throws java.text.ParseException
Throws:
java.text.ParseException

LocalizedTime

public static final java.lang.String LocalizedTime(java.lang.String sTime,
                                                   boolean bMilitary)
                                            throws java.text.ParseException
Throws:
java.text.ParseException

ShortLocalizedTime

public static final java.lang.String ShortLocalizedTime(java.lang.String sTime,
                                                        boolean bMilitary)
                                                 throws java.text.ParseException
Throws:
java.text.ParseException

CalcFloatingDate

public static final java.lang.String CalcFloatingDate(int nDayOfMonthOffset,
                                                      int nDayOfMonthDay,
                                                      int nMonth,
                                                      int nYear)
                                               throws java.text.ParseException
Throws:
java.text.ParseException

StringToDate

public static final java.util.Date StringToDate(java.lang.String str,
                                                java.lang.String pattern)
                                         throws java.text.ParseException
Converts a string to a date object

Parameters:
str -
pattern -
Returns:
Throws:
java.text.ParseException

DateToString

public static final java.lang.String DateToString(java.util.Date date,
                                                  java.lang.String pattern)
Converts a date object to a string

Parameters:
date -
pattern -
Returns:

DateStringToDate

public static final java.util.Date DateStringToDate(java.lang.String sDate)
                                             throws java.text.ParseException
Converts a preformatted date string to a date object

Parameters:
sDate -
Returns:
Throws:
java.text.ParseException

TimeStringToDate

public static final java.util.Date TimeStringToDate(java.lang.String sTime)
                                             throws java.text.ParseException
Converts a preformatted time string to a date object

Parameters:
sTime -
Returns:
Throws:
java.text.ParseException

DateToStringDate

public static final java.lang.String DateToStringDate(java.util.Date date)
Converts a date object to a preformatted date string

Parameters:
date -
Returns:

DateToStringTime

public static final java.lang.String DateToStringTime(java.util.Date date)
Converts a date object to a preformatted time string

Parameters:
date -
Returns:

FormatDate

public static final java.lang.String FormatDate(int nMonth,
                                                int nDay,
                                                int nYear)
Formats the integer values of a date to a preformatted date string

Parameters:
nMonth -
nDay -
nYear -
Returns:

FormatDate

public static final java.lang.String FormatDate(int nMonth,
                                                int nDay,
                                                int nYear,
                                                java.lang.String sPattern)

FormatTime

public static final java.lang.String FormatTime(int nHour,
                                                int nMin,
                                                int nSec)
Formats the integer values of a time to a preformatted time string

Parameters:
nHour -
nMin -
nSec -
Returns:

TimeToSecond

public static final long TimeToSecond(java.lang.String sTime)

TimeToMinute

public static final long TimeToMinute(java.lang.String sTime)

TimeToHour

public static final long TimeToHour(java.lang.String sTime)

DateToDay

public static final long DateToDay(java.lang.String sDate)

DateToMonth

public static final long DateToMonth(java.lang.String sDate)

DateToYear

public static final long DateToYear(java.lang.String sDate)

CurrentDate

public static final java.lang.String CurrentDate()

CurrentTime

public static final java.lang.String CurrentTime()

TimeDateDiff

public static final long TimeDateDiff(java.lang.String sTimeDate1,
                                      java.lang.String sTimeDate2,
                                      int nTimeField,
                                      ObjectRef rbOneLtTwo)
                               throws java.text.ParseException
Gets the select difference between two time values

Parameters:
sTimeDate1 - must be in either (MM/DD/YYYY) date format or (hh:mm:ss) time format
sTimeDate2 - must be in either (MM/DD/YYYY) date format or (hh:mm:ss) time format
nTimeField - Calendar field modifier (ie Calendar.YEAR, Calendar.HOUR)
rbOneLtTwo - must be a boolean type return value
Returns:
a long value containing the time difference based on the field modifier passed in
Throws:
java.text.ParseException

getNextTimeout

public static final long getNextTimeout(long timeout)
Adds the specified number of milliseconds to the current time and returns the added value

Parameters:
timeout - number of milliseconds
Returns:
adjusted time in milliseconds

isTimeExpired

public static final boolean isTimeExpired(long timeout)
Checks to see if the current time is greater than the specified time in milliseconds

Parameters:
timeout - time in milliseconds
Returns:
true is the time is expired; false otherwise


Copyright © 2008 AMX LLC. All Rights Reserved.