DateTime (axelframework 3.1.12.RELEASE API)

java.lang.Object
- org.xmlactions.common.util.DateTime

public class DateTime
extends java.lang.Object

Date and Time functionality

Since:: 29 April 2001

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class DateTime.datetime

Nested Classes
Modifier and Type	Class and Description
`class`	`DateTime.datetime`

Constructor Summary

Constructors
Constructor and Description

DateTime()

Constructors
Constructor and Description
`DateTime()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.Calendar`	`changeDate(java.util.Calendar base, int iChangeAmount)`
`static java.util.Calendar`	`changeDate(int iDay, int iMonth, int iYear, int iChangeAmount)`
`DateTime.datetime`	`convertDateStringToDateTime(java.lang.String sDate)`
`static java.lang.String`	`formatDate(long datetime, java.lang.String pattern)` Format the output for date time using SimpleDateFormat Customized Date and Time Formats Pattern Output dd.MM.yy 09.04.98 yyyy.MM.dd G 'at' hh:mm:ss z 1998.04.09 AD at 06:15:55 PDT EEE, MMM d, ''yy Thu, Apr 9, '98 h:mm a 6:15 PM H:mm 18:15 H:mm:ss:SSS 18:15:55:624 K:mm a,z 6:15 PM,PDT yyyy.MMMMM.dd GGG hh:mm aaa 1998.April.09 AD 06:15 PM
`static java.lang.String`	`getAbbDayText(int iDayOfWeek)`
`static java.lang.String`	`getAbbMonthText(int monthNum)` Get abbreviated month text.
`static java.lang.String`	`getDate()` Convert the current time in milliseconds to a string.
`static java.lang.String`	`getDate(long milliseconds)` Convert a time in milliseconds to a string.
`static java.lang.String`	`getDate(long milliseconds, java.lang.String outFormat)` Convert a time in string format to milliseconds The recognised formats are: 'dd' = day 'mo' = month 'MO' = abbreviated month text 'yy' = year 'YY' = year (2 digit) 'hh' = hour 'mm' = minute 'ss' = sec '..' = milli
`static java.lang.String`	`getDate(long milliseconds, java.lang.String dateSeperator, java.lang.String timeSeperator)` Convert a time in milliseconds to a string.
`static long`	`getDate(java.lang.String date, java.lang.String inFormat)` Convert a time in string format to milliseconds The recognised formats are: 'dd' = day 'mo' = month 'MO' = abbreviated month text 'yy' = year 'YY' = year (2 digit) 'hh' = hour 'mm' = minute 'ss' = sec '..' = millisecond
`static java.lang.String`	`getDate(java.lang.String date, java.lang.String inFormat, java.lang.String outFormat)` Convert a time in string format to milliseconds The recognised formats are: 'dd' = day 'mo' = month 'MO' = abbreviated month text 'yy' = year 4 digit 'YY' = year (2 digit) 'hh' = hour 'mm' = minute 'ss' = sec
`static long`	`getDateInMillis()` gets the current time on milliseconds
`static int`	`getDayOfWeek(int iDay, int iMonth, int iYear)`
`static int`	`getDaysInMonth(int iMonth, int iYear)`
`static java.lang.String`	`getDayText(int iDayOfWeek)`
`static int`	`getMonthFromAbbText(java.lang.String month)` Get month number from abbreviated month text.
`static int`	`getMonthNumber(java.lang.String sMonthOfYear)` Convert a month in string format (January) to a number.
`static java.lang.String`	`getMonthText(int monthNum)` Get month text.
`static java.lang.String`	`getSQLDateFormat(int day, int month, int year, java.lang.String time)` Get the database format for storing a date.
`static java.lang.String`	`getSQLDateFormat(java.lang.String sDay, java.lang.String sMonth, java.lang.String sYear, java.lang.String sTime)` Get the database format for storing a date.
`static boolean`	`isLeapYear(int iYear)`
`java.lang.String`	`milliTimeToFullShowTime(long milliTime)` Convert a millisecond time to HH:MM:SS:MMMM
`static java.lang.String`	`milliTimeToShowTime(long milliTime)` Convert a millisecond time to HH:MM:SS
`java.lang.String`	`out_getDate(long milliseconds, java.lang.String format)` Convert a time in milliseconds to a string. The recognised formats are: 'dd' = day 'mo' = month 'MO' = abbreviated month text 'yy' = year 'YY' = year (2 digit) 'hh' = hour 'mm' = minute 'ss' = sec
`static java.lang.String`	`validateDate(java.lang.String date, java.lang.String format)` Validates the a date string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DateTime
```
public DateTime()
```
- Method Detail
  - getDaysInMonth
```
public static int getDaysInMonth(int iMonth,
                                 int iYear)
```
    Parameters:
    
    iMonth - ranging from 0-11 not 1-12
    
    iYear - 4 digits as in 2001 and not 01
    
    Returns:
    
    number of days in month
    
    Since:
    
    29 Apr 2001
    get the number of days in a month
  - isLeapYear
```
public static boolean isLeapYear(int iYear)
```
    Parameters:
    
    iYear - 4 digits as in 2001 and not 01
    
    Returns:
    
    true if the entered year is a leap year otherwise false.
    
    Since:
    
    29 Apr 2001
    check if the entered year is a leap year
  - getDayOfWeek
```
public static int getDayOfWeek(int iDay,
                               int iMonth,
                               int iYear)
```
    Parameters:
    
    iDay - ranging from 1-28/31
    
    iMonth - ranging from 0-11 not 1-12
    
    iYear - 4 digits as in 2001 and not 01
    
    Returns:
    
    1 to 7 where 1=Sunday, 2=Monday etc.
    
    Since:
    
    29 Apr 2001
    get the day of the week 1 - 7. Developer must ensure the validity of the parameters entered.
  - changeDate
```
public static java.util.Calendar changeDate(int iDay,
                                            int iMonth,
                                            int iYear,
                                            int iChangeAmount)
```
    Parameters:
    
    iDay - ranging from 1-28/31
    
    iMonth - ranging from 0-11 not 1-12
    
    iYear - 4 digits as in 2001 and not 01
    
    iChangeAmount - is the number of days to change the date by.
    
    Returns:
    
    1 to 7 where 1=Sunday, 2=Monday etc.
    
    Since:
    
    30 Apr 2001
    Change the date by a number of days.
  - changeDate
```
public static java.util.Calendar changeDate(java.util.Calendar base,
                                            int iChangeAmount)
```
    Parameters:
    
    base - is the base date
    
    iChangeAmount - amount to change date by in days
    
    Returns:
    
    1 to 7 where 1=Sunday, 2=Monday etc.
    
    Since:
    
    30 Apr 2001
    Change the date by a number of days.
  - getDateInMillis
```
public static long getDateInMillis()
```
    gets the current time on milliseconds
    
    Returns:
    
    current time in milliseconds
  - getDate
```
public static java.lang.String getDate()
```
    Convert the current time in milliseconds to a string.
    
    Returns:
    
    the time converted to a string.
  - getDate
```
public static java.lang.String getDate(long milliseconds)
```
    Convert a time in milliseconds to a string.
    
    Parameters:
    
    milliseconds - is the time in milliseconds.
    
    Returns:
    
    the time converted to a string.
  - getDate
```
public static java.lang.String getDate(long milliseconds,
                                       java.lang.String dateSeperator,
                                       java.lang.String timeSeperator)
```
    Convert a time in milliseconds to a string.
    
    Parameters:
    
    milliseconds - is the time in milliseconds.
    
    dateSeperator - is the seperator char to use between year mon day
    
    timeSeperator - is the seperator char to use between hour min sec
    
    Returns:
    
    the time converted to a string.
  - out_getDate
```
public java.lang.String out_getDate(long milliseconds,
                                    java.lang.String format)
```
    Convert a time in milliseconds to a string.
    The recognised formats are:
    'dd' = day
    'mo' = month
    'MO' = abbreviated month text
    'yy' = year
    'YY' = year (2 digit)
    'hh' = hour
    'mm' = minute
    'ss' = sec
    
    Parameters:
    
    milliseconds - is the time in milliseconds.
    
    format - is the format of the date we want returned, i.e. dd-MO-yy hh:mm:ss = day number, MO = month as text etc. 'dd' = day, 'mo' = month, 'MO' = month text 'yy' = year, 'hh' = hour, 'mm' = minute, 'ss' = sec
    
    Returns:
    
    the time converted to a string.
  - getDate
```
public static java.lang.String getDate(long milliseconds,
                                       java.lang.String outFormat)
```
    Convert a time in string format to milliseconds
    The recognised formats are:
    'dd' = day
    'mo' = month
    'MO' = abbreviated month text
    'yy' = year
    'YY' = year (2 digit)
    'hh' = hour
    'mm' = minute
    'ss' = sec
    '..' = milli
    
    Parameters:
    
    milliseconds - is the date we want converted
    
    outFormat - is the format of the date we want returned, i.e. dd-MO-yy hh:mm:ss = day number, MO = month as text etc. 'dd' = day, 'mo' = month, 'MO' = month text 'yy' = year, 'hh' = hour, 'mm' = minute, 'ss' = sec, '..' = millisecond
    
    Returns:
    
    the date converted to milliseconds.
  - getDate
```
public static long getDate(java.lang.String date,
                           java.lang.String inFormat)
```
    Convert a time in string format to milliseconds
    The recognised formats are:
    'dd' = day
    'mo' = month
    'MO' = abbreviated month text
    'yy' = year
    'YY' = year (2 digit)
    'hh' = hour
    'mm' = minute
    'ss' = sec
    '..' = millisecond
    
    Parameters:
    
    date - is the date we want converted to milliseconds
    
    inFormat - is the format of the date we want returned, i.e. dd-MO-yy hh:mm:ss = day number, MO = month as text etc. 'dd' = day, 'mo' = month, 'MO' = month text 'yy' = year, 'hh' = hour, 'mm' = minute, 'ss' = sec, '..' = millisecond
    
    Returns:
    
    the date converted to milliseconds.
  - getDate
```
public static java.lang.String getDate(java.lang.String date,
                                       java.lang.String inFormat,
                                       java.lang.String outFormat)
                                throws java.lang.Exception
```
    Convert a time in string format to milliseconds
    The recognised formats are:
    'dd' = day
    'mo' = month
    'MO' = abbreviated month text
    'yy' = year 4 digit
    'YY' = year (2 digit)
    'hh' = hour
    'mm' = minute
    'ss' = sec
    
    Parameters:
    
    date - is the date we want converted to milliseconds
    
    inFormat - is the format of the date we want returned, i.e. dd-MO-yy hh:mm:ss = day number, MO = month as text etc. 'dd' = day, 'mo' = month, 'MO' = month text 'yy' = year, 'hh' = hour, 'mm' = minute, 'ss' = sec
    
    outFormat - is the format of the date we want returned, i.e. dd-MO-yy hh:mm:ss = day number, MO = month as text etc. 'dd' = day, 'mo' = month, 'MO' = month text 'yy' = year, 'hh' = hour, 'mm' = minute, 'ss' = sec
    
    Returns:
    
    the date converted to milliseconds.
    
    Throws:
    
    java.lang.Exception
  - getMonthText
```
public static java.lang.String getMonthText(int monthNum)
```
    Get month text.
    
    Parameters:
    
    monthNum - between 0 and 11
    
    Returns:
    
    month like January or Feburary
  - getDayText
```
public static java.lang.String getDayText(int iDayOfWeek)
```
  - getAbbDayText
```
public static java.lang.String getAbbDayText(int iDayOfWeek)
```
  - getAbbMonthText
```
public static java.lang.String getAbbMonthText(int monthNum)
```
    Get abbreviated month text.
    
    Parameters:
    
    monthNum - between 0 and 11
    
    Returns:
    
    abbreviated month like JAN or FEB
  - getMonthFromAbbText
```
public static int getMonthFromAbbText(java.lang.String month)
```
    Get month number from abbreviated month text. This is an ignoreCase comparision.
    
    Parameters:
    
    month - abbreviated format for month like "JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC"
    
    Returns:
    
    month number 0 for January or -1 if no match found
  - getSQLDateFormat
```
public static java.lang.String getSQLDateFormat(int day,
                                                int month,
                                                int year,
                                                java.lang.String time)
```
    Get the database format for storing a date.
    
    Parameters:
    
    day - = day of month
    
    month - = month of year
    
    year - = year
    
    time - = time between 0:0:0 and 23:59:59
    
    Returns:
    
    the formatted string entry for date and time
    i.e. '25 JAN 1958 10:00:00'
  - getSQLDateFormat
```
public static java.lang.String getSQLDateFormat(java.lang.String sDay,
                                                java.lang.String sMonth,
                                                java.lang.String sYear,
                                                java.lang.String sTime)
```
    Get the database format for storing a date.
    
    Parameters:
    
    sDay - = day of month
    
    sMonth - = month of year
    
    sYear - = year
    
    sTime - = time between 0:0:0 and 23:59:59
    
    Returns:
    
    the formatted string entry for date and time
    i.e. '25 JAN 1958 10:00:00'
  - validateDate
```
public static java.lang.String validateDate(java.lang.String date,
                                            java.lang.String format)
```
    Validates the a date string. The format will determine which characters in the date should be numbers.
    
    Parameters:
    
    date - is the date string we want to validate
    
    format - is the expected format of the date string. The format should contain a 'n' for a number, a 'l' for a letter and a 'x' for anything else
    
    Returns:
    
    a string of the error if the formats is not correct else a null if the format is correct.
  - getMonthNumber
```
public static int getMonthNumber(java.lang.String sMonthOfYear)
```
    Convert a month in string format (January) to a number.
    
    Parameters:
    
    sMonthOfYear -
    
    Returns:
    
    month number between 0 and 11 or -1 on error
    
    Since:
    
    4/13/2001 11:27PM
  - milliTimeToShowTime
```
public static java.lang.String milliTimeToShowTime(long milliTime)
```
    Convert a millisecond time to HH:MM:SS
  - milliTimeToFullShowTime
```
public java.lang.String milliTimeToFullShowTime(long milliTime)
```
    Convert a millisecond time to HH:MM:SS:MMMM
  - convertDateStringToDateTime
```
public DateTime.datetime convertDateStringToDateTime(java.lang.String sDate)
```
    Parameters:
    
    sDate - is the date to set format = 'dd-mm-yyyy hh:mm:ss'
    
    Returns:
    
    datetime class containing the parsed parts.
    
    Since:
    
    4 April 2006 Converts a date String to a datetime class.
  - formatDate
```
public static java.lang.String formatDate(long datetime,
                                          java.lang.String pattern)
```
    Format the output for date time using SimpleDateFormat
    Customized Date and Time Formats Pattern Output
    dd.MM.yy 09.04.98
    yyyy.MM.dd G 'at' hh:mm:ss z 1998.04.09 AD at 06:15:55 PDT
    EEE, MMM d, ''yy Thu, Apr 9, '98
    h:mm a 6:15 PM
    H:mm 18:15
    H:mm:ss:SSS 18:15:55:624
    K:mm a,z 6:15 PM,PDT
    yyyy.MMMMM.dd GGG hh:mm aaa 1998.April.09 AD 06:15 PM
    
    Parameters:
    
    datetime -
    
    pattern -
    
    Returns:
    
    formatted date

Class DateTime

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DateTime

Method Detail

getDaysInMonth

isLeapYear

getDayOfWeek

changeDate

changeDate

getDateInMillis

getDate

getDate

getDate

out_getDate

getDate

getDate

getDate

getMonthText

getDayText

getAbbDayText

getAbbMonthText

getMonthFromAbbText

getSQLDateFormat

getSQLDateFormat

validateDate

getMonthNumber

milliTimeToShowTime

milliTimeToFullShowTime

convertDateStringToDateTime

formatDate