Package com.logicaldoc.core.automation
Class AutomationDateTool
java.lang.Object
org.apache.velocity.tools.generic.SafeConfig
org.apache.velocity.tools.generic.LocaleConfig
org.apache.velocity.tools.generic.FormatConfig
org.apache.velocity.tools.generic.DateTool
com.logicaldoc.core.automation.AutomationDateTool
- All Implemented Interfaces:
Serializable
public class AutomationDateTool
extends org.apache.velocity.tools.generic.DateTool
Utility class to handle dates from inside the Automation
- Since:
- 7.3
- Author:
- Marco Meschieri - LogicalDOC
- See Also:
-
Field Summary
Fields inherited from class org.apache.velocity.tools.generic.DateTool
TIMEZONE_KEY
Fields inherited from class org.apache.velocity.tools.generic.FormatConfig
DEFAULT_FORMAT, FORMAT_KEY
Fields inherited from class org.apache.velocity.tools.generic.LocaleConfig
DEFAULT_LOCALE
Fields inherited from class org.apache.velocity.tools.generic.SafeConfig
LOCK_CONFIG_KEY, LOGGER_NAME_KEY, SAFE_MODE_KEY, USE_CLASS_LOGGER_KEY
-
Constructor Summary
ConstructorDescriptionAutomationDateTool
(String dateFormat, String dateFormatLong, String dateFormatShort) AutomationDateTool
(Locale locale) -
Method Summary
Modifier and TypeMethodDescriptionAdds a given amount of days to a date(you can add negative values to go back in time)addMilliseconds
(Date src, int amount) Adds a given amount of milliseconds to a date(you can add negative values to go back in time)addMinutes
(Date src, int amount) Adds a given amount of minutes to a date(you can add negative values to go back in time)Adds a given amount of months to a date(you can add negative values to go back in time)addSeconds
(Date src, int amount) Adds a given amount of seconds to a date(you can add negative values to go back in time)Adds a given amount of years to a date(you can add negative values to go back in time)Gets the current timeFormats a dateFormats a date using a specific formatFormats a dateFormats a date using a specific formatformatDate
(Date date) Formats a date using the normal format that also includes the timeformatDate
(Date date, String timeZone) Formats a date using the normal format that also includes the timeformatDateLong
(Date date) Formats a date using the long format that includes the time and millisecondsformatDateLong
(Date date, String timeZone) Formats a date using the long format that includes the time and millisecondsformatDateShort
(Date date) Formats a date using the short format that just includes the dateformatDateShort
(Date date, String timeZone) Formats a date using the short format that just includes the dateFormats a date using the ISO format:yyyy-MM-dd'T'HH:mm:ss
Formats a date using the SQL format:yyyy-MM-dd
Retrieves the default date format with time specification adn millisecondsRetrieves the default date format without time specificationParses a string and to retrieve a datevoid
setDateFormat
(String dateFormat) void
setDateFormatLong
(String dateFormatLong) Sets the default long format(date with time)void
setDateFormatShort
(String dateFormatShort) Sets the default short format(date without time)void
setTimeZone
(String timeZone) long
toDays
(long ms) Calculates how many days are contained in a given amount of millisecondslong
toHours
(long ms) Calculates how many hours are contained in a given amount of millisecondslong
toMinutes
(long ms) Calculates how many minutes are contained in a given amount of millisecondslong
toMonths
(long ms) Calculates how many months are contained in a given amount of millisecondslong
toSeconds
(long ms) Calculates how many seconds are contained in a given amount of millisecondslong
toWeeks
(long ms) Calculates how many weeks are contained in a given amount of millisecondslong
toYears
(long ms) Calculates how many years are contained in a given amount of millisecondsMethods inherited from class org.apache.velocity.tools.generic.DateTool
format, format, format, format, format, format, format, get, get, getCalendar, getDate, getDateFormat, getDateFormat, getDay, getDay, getMonth, getMonth, getSystemCalendar, getSystemDate, getSystemTime, getValue, getValue, getValue, getYear, getYear, toCalendar, toCalendar, toCalendar, toCalendar, toCalendar, toDate, toDate, toDate, toDate, toDate, toDate, toLocalizedPattern, toString
Methods inherited from class org.apache.velocity.tools.generic.FormatConfig
getFormat
Methods inherited from class org.apache.velocity.tools.generic.LocaleConfig
getLocale, toLocale
Methods inherited from class org.apache.velocity.tools.generic.SafeConfig
configure, isConfigLocked, isSafeMode
-
Constructor Details
-
AutomationDateTool
-
AutomationDateTool
-
AutomationDateTool
public AutomationDateTool()
-
-
Method Details
-
format
Formats a date- Parameters:
date
- the date to formattimeZone
- the time zonetime
- if the output must contain the time also- Returns:
- the formatted string
-
format
Formats a date- Parameters:
date
- the date to formattime
- if the output must contain the time also- Returns:
- the formatted string
-
formatDate
Formats a date using the normal format that also includes the time- Parameters:
date
- the date to formattimeZone
- the time zone- Returns:
- the formatted string
-
formatDate
Formats a date using the normal format that also includes the time- Parameters:
date
- the date to format- Returns:
- the formatted string
-
formatDateShort
Formats a date using the short format that just includes the date- Parameters:
date
- the date to formattimeZone
- the time zone- Returns:
- the formatted string
-
formatDateShort
Formats a date using the short format that just includes the date- Parameters:
date
- the date to format- Returns:
- the formatted string
-
formatDateLong
Formats a date using the long format that includes the time and milliseconds- Parameters:
date
- the date to formattimeZone
- the time zone- Returns:
- the formatted string
-
formatDateLong
Formats a date using the long format that includes the time and milliseconds- Parameters:
date
- the date to format- Returns:
- the formatted string
-
formatISO
Formats a date using the ISO format:yyyy-MM-dd'T'HH:mm:ss
- Parameters:
date
- the date to format- Returns:
- the formatted string
-
formatSQL
Formats a date using the SQL format:yyyy-MM-dd
- Parameters:
date
- the date to format- Returns:
- the formatted string
-
format
Formats a date using a specific format- Parameters:
date
- the date to formatformat
- the format to use eg: dd/MM/yyyytimeZone
- the time zone- Returns:
- the formatted string
- See Also:
-
format
Formats a date using a specific format- Parameters:
date
- the date to formatformat
- the format to use eg: dd/MM/yyyy- Returns:
- the formatted string
- See Also:
-
parse
Parses a string and to retrieve a date- Parameters:
date
- string to parseformat
- the format to use- Returns:
- the parsed date
- See Also:
-
getDateFormatShort
Retrieves the default date format without time specification- Returns:
- the default date short format
-
setDateFormatShort
Sets the default short format(date without time)- Parameters:
dateFormatShort
- the short format
-
getDateFormatLong
Retrieves the default date format with time specification adn milliseconds- Returns:
- the default date long format
-
setDateFormatLong
Sets the default long format(date with time)- Parameters:
dateFormatLong
- the long format
-
currentTime
Gets the current time- Returns:
- the current time
-
addYears
Adds a given amount of years to a date(you can add negative values to go back in time)- Parameters:
src
- the date to useamount
- number of years- Returns:
- the new date
-
addMonths
Adds a given amount of months to a date(you can add negative values to go back in time)- Parameters:
src
- the date to useamount
- number of months- Returns:
- the new date
-
addDays
Adds a given amount of days to a date(you can add negative values to go back in time)- Parameters:
src
- the date to useamount
- number of days- Returns:
- the new date
-
addMinutes
Adds a given amount of minutes to a date(you can add negative values to go back in time)- Parameters:
src
- the date to useamount
- number of minutes- Returns:
- the new date
-
addSeconds
Adds a given amount of seconds to a date(you can add negative values to go back in time)- Parameters:
src
- the date to useamount
- number of seconds- Returns:
- the new date
-
addMilliseconds
Adds a given amount of milliseconds to a date(you can add negative values to go back in time)- Parameters:
src
- the date to useamount
- number of milliseconds- Returns:
- the new date
-
toDays
public long toDays(long ms) Calculates how many days are contained in a given amount of milliseconds- Parameters:
ms
- the milliseconds- Returns:
- number of days
-
toHours
public long toHours(long ms) Calculates how many hours are contained in a given amount of milliseconds- Parameters:
ms
- the milliseconds- Returns:
- number of hours
-
toMinutes
public long toMinutes(long ms) Calculates how many minutes are contained in a given amount of milliseconds- Parameters:
ms
- the milliseconds- Returns:
- number of minutes
-
toMonths
public long toMonths(long ms) Calculates how many months are contained in a given amount of milliseconds- Parameters:
ms
- the milliseconds- Returns:
- number of months
-
toSeconds
public long toSeconds(long ms) Calculates how many seconds are contained in a given amount of milliseconds- Parameters:
ms
- the milliseconds- Returns:
- number of seconds
-
toWeeks
public long toWeeks(long ms) Calculates how many weeks are contained in a given amount of milliseconds- Parameters:
ms
- the milliseconds- Returns:
- number of weeks
-
toYears
public long toYears(long ms) Calculates how many years are contained in a given amount of milliseconds- Parameters:
ms
- the milliseconds- Returns:
- number of years
-
getDateFormat
-
setDateFormat
-
getTimeZone
- Overrides:
getTimeZone
in classorg.apache.velocity.tools.generic.DateTool
-
setTimeZone
-