@script::formatDate

The formatDate method for the default script object formats the provided date value into a date string using the specified format and time zone.

Syntax:

@script::formatDate(long dateValue, String timeZoneId, String format)

Parameters:

Returns:

(string) Representation of a date

Example:

The following example illustrates three methods of using formatDate to format a specific date value:

@script::log("---FormatDate01---")

$dateValue = 1217314800000L

@script::log("DateValue: " & $dateValue)

$dateFormat = "yyyy-MM-dd"

@script::log("DateFormat: " & $dateFormat)

$dateString = @script::formatDate($dateValue,"PST",$dateFormat)

@script::log("Date String: " & $dateString)

@script::log("-----------------------")

 

@script::log("---FormatDate02---")

$dateValue = 994277336000L

@script::log("DateValue: " & $dateValue)

$dateFormat = "yyyy.MM.dd G 'at' HH:mm:ss z"

@script::log("DateFormat: " & $dateFormat)

$dateString = @script::formatDate($dateValue,"PST",$dateFormat)

@script::log("Date String: " & $dateString)

@script::log("-----------------------")

 

@script::log("---FormatDate03---")

$dateValue = 994230000000L

@script::log("DateValue: " & $dateValue)

$dateFormat = "EEE, MMM d, ''yy"

@script::log("DateFormat: " & $dateFormat)

$dateString = @script::formatDate($dateValue,"PST",$dateFormat)

@script::log("Date String: " & $dateString)

@script::log("-----------------------")

Output:

2008-05-26 16:16:38,978 [processBroker.9] INFO - ---FormatDate01---
2008-05-26 16:16:38,994 [processBroker.9] INFO - DateValue: 1217314800000
2008-05-26 16:16:38,994 [processBroker.9] INFO - DateFormat: yyyy-MM-dd
2008-05-26 16:16:38,994 [processBroker.9] INFO - Date String: 2008-07-29
2008-05-26 16:16:38,994 [processBroker.9] INFO - -----------------------
2008-05-26 16:16:38,994 [processBroker.9] INFO - ---FormatDate02---
2008-05-26 16:16:38,994 [processBroker.9] INFO - DateValue: 994277336000
2008-05-26 16:16:38,994 [processBroker.9] INFO - DateFormat: yyyy.MM.dd G 'at' HH:mm:ss z
2008-05-26 16:16:38,994 [processBroker.9] INFO - Date String: 2001.07.04 AD at 13:08:56 PDT
2008-05-26 16:16:38,994 [processBroker.9] INFO - -----------------------
2008-05-26 16:16:38,994 [processBroker.9] INFO - ---FormatDate03---
2008-05-26 16:16:38,994 [processBroker.9] INFO - DateValue: 994230000000
2008-05-26 16:16:38,994 [processBroker.9] INFO - DateFormat: EEE, MMM d, ''yy
2008-05-26 16:16:38,994 [processBroker.9] INFO - Date String: Wed, Jul 4, '01

Formatting dates and times