oracle.ifs.common

Class DateUtilities

java.lang.Object

oracle.ifs.common.DateUtilities

public class DateUtilities
extends Object

Provides miscellaneous utility methods for date processing.

Version:

1.0

Author:

Dave Long

(Published)

Method Summary

Modifier and Type	Method and Description
static Long	calculateInitialDelay(long period, String baseTimeVal, SimpleDateFormat df) Computes the number of milliseconds for the initial delay, from a BaseTimeOfDay setting, which may include a date.
static Long	convertTimerInterval(String value) Computes the number of milliseconds in a period of time specified as a string.
static Long	convertTimerInterval(String value, long defValue) Computes the number of milliseconds in a period of time specified as a string, and default to the specified value if the specified string is not legal or is null.
static Long	convertTimerInterval(String value, String daySuffix, String hourSuffix, String minuteSuffix, String secondSuffix) Computes the number of milliseconds in a period of time specified as a string.
static void	verifyTimeOfDayString(String value) Verified a specification of a time-of-day.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

convertTimerInterval

public static Long convertTimerInterval(String value)
                                 throws IfsException

Computes the number of milliseconds in a period of time specified as a string.

For example, convert "36s" to new Long(36000).

Parameters:

value - string value to be converted

Returns:

the time interval, in milliseconds

Throws:

IfsException - if the operation fails

(Unpublished)

convertTimerInterval

public static Long convertTimerInterval(String value,
                                        long defValue)

Computes the number of milliseconds in a period of time specified as a string, and default to the specified value if the specified string is not legal or is null.

Parameters:

value - string value to be converted

defValue - string value to be converted

Returns:

the time interval, in milliseconds

Throws:

IfsException - if the operation fails

(Unpublished)

convertTimerInterval

public static Long convertTimerInterval(String value,
                                        String daySuffix,
                                        String hourSuffix,
                                        String minuteSuffix,
                                        String secondSuffix)
                                 throws IfsException

Computes the number of milliseconds in a period of time specified as a string.

For example, convert "36s" to 36000 ms.

Parameters:

value - string value to be converted

daySuffix - suffix used for day

hourSuffix - suffix used for hour

minuteSuffix - suffix used for minute

secondSuffix - suffix used for second

Returns:

the time interval, in milliseconds

Throws:

IfsException - if the operation fails

(Unpublished)

verifyTimeOfDayString

public static void verifyTimeOfDayString(String value)
                                  throws IfsException

Verified a specification of a time-of-day.

Verifies that the string specified represents a 24-hour time specification.

Parameters:

value - string value to be checked

Throws:

IfsException - if the operation fails

(Unpublished)

calculateInitialDelay

public static Long calculateInitialDelay(long period,
                                         String baseTimeVal,
                                         SimpleDateFormat df)
                                  throws IfsException

Computes the number of milliseconds for the initial delay, from a BaseTimeOfDay setting, which may include a date.

This delay is based on the current time, the specified base time, and the specified Period. The returned delay will never be greater than the specified period.

Parameters:

period - cycle period (in ms)

baseTimeVal - base time string value

df - DateFormatter to use for the translation

Returns:

the number of milliseconds of the initial delay

Throws:

IfsException - (IFS-45349) if the operation fails