DateUtil (Fujion Common Library 1.0.20 API)

java.lang.Object
- org.fujion.common.DateUtil

```
public class DateUtil
extends Object
```
Utility methods for managing dates.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DateUtil.Format` Enum representing common date formats.
`static class`	`DateUtil.TimeUnit` Represents time units in order of increasing precision.

Field Summary

Fields
Modifier and Type Field and Description

static String[][] TIME_UNIT
Labels for time units.

Fields
Modifier and Type	Field and Description
`static String[][]`	`TIME_UNIT` Labels for time units.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Date`	`addDays(Date date, int daysOffset, boolean stripTime)` Adds specified number of days to date and, optionally strips the time component.
`static Date`	`cloneDate(Date date)` Clones a date.
`static int`	`compare(Date date1, Date date2)` Compares two dates.
`static Date`	`endOfDay(Date date)` Returns the input date with the time set to the end of the day.
`static String`	`formatAge(Date dob)` Returns age as a formatted string expressed in days, months, or years, depending on whether person is an infant (< 2 mos), toddler (> 2 mos, < 2 yrs), or more than 2 years old.
`static String`	`formatAge(Date dob, boolean pluralize, Date refDate)` Returns age as a formatted string expressed in days, months, or years, depending on whether person is an infant (< 2 mos), toddler (> 2 mos, < 2 yrs), or more than 2 years old.
`static String`	`formatDate(Date date)` Converts a date/time value to a string, using the format dd-mmm-yyyy hh:mm.
`static String`	`formatDate(Date date, boolean showTimezone)` Converts a date/time value to a string, using the format dd-mmm-yyyy hh:mm.
`static String`	`formatDate(Date date, boolean showTimezone, boolean ignoreTime)` Converts a date/time value to a string, using the format dd-mmm-yyyy hh:mm.
`static String`	`formatDate(Date date, String timeSeparator)` Same as formatDate(Date, boolean) except replaces the time separator with the specified string.
`static String`	`formatDuration(long duration)` Formats a duration in ms.
`static String`	`formatDuration(long duration, DateUtil.TimeUnit accuracy)` Formats a duration in ms to the specified accuracy.
`static String`	`formatDuration(long duration, DateUtil.TimeUnit accuracy, boolean pluralize, boolean abbreviated)` Formats a duration in ms to the specified accuracy.
`static String`	`formatElapsed(double elapsed)` Return elapsed time in ms to displayable format with units.
`static String`	`formatElapsed(double elapsed, boolean pluralize, boolean abbreviated, boolean round)` Return elapsed time in ms to displayable format with units.
`static String`	`formatElapsed(double elapsed, boolean pluralize, boolean abbreviated, boolean round, DateUtil.TimeUnit minUnits)` Return elapsed time in ms to displayable format with units.
`static String`	`formatElapsed(double elapsed, DateUtil.TimeUnit minUnits)` Return elapsed time in ms to displayable format with units.
`static TimeZone`	`getLocalTimeZone()` Returns the user's time zone.
`static boolean`	`hasTime(Date date)` Returns true if the date has an associated time.
`static Date`	`now()` Returns a date with the current time.
`static Date`	`parseDate(String s)` Convert a string value to a date/time.
`static Date`	`parseDate(String value, String... patterns)` Attempts to parse an input value using one of several patterns.
`static double`	`parseElapsed(String value)` Parses an elapsed time string, returning time in milliseconds.
`static double`	`parseElapsed(String value, DateUtil.TimeUnit units)` Parses an elapsed time string, returning time in specified units.
`static Date`	`stripTime(Date date)` Strips the time component from a date.
`static Date`	`toDate(int day, int month, int year)` Converts day, month, and year to a date.
`static Date`	`toDate(int day, int month, int year, int hr, int min, int sec)` Converts day, month, year and time parameters to a date.
`static Date`	`today()` Returns a date with the current day (no time).
`static String`	`toHL7(Date date)` Convert a date to HL7 format.

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

- Field Detail
  - TIME_UNIT
```
public static String[][] TIME_UNIT
```
    Labels for time units. TODO: externalize these for localization support.
- Method Detail
  - parseDate
```
public static Date parseDate(String s)
```
    Convert a string value to a date/time. Attempts to convert using the four locale-specific date formats (FULL, LONG, MEDIUM, SHORT). If these fail, looks to see if T+/-offset or N+/-offset is used.
    
    TODO: probably we can make the "Java parse" portion a bit smarter by using a better variety of formats, maybe to catch Euro-style input as well.
    
    TODO: probably we can add something like "t+d" or "t-y" as valid cases; in these scenarios, the coefficient was omitted and could be defaulted to 1.
    
    Parameters:
    
    s - String containing value to be converted.
    
    Returns:
    
    Date object corresponding to the input value, or null if the parsing failed to resolve a valid Date.
  - parseDate
```
public static Date parseDate(String value,
                             String... patterns)
                      throws ParseException
```
    Attempts to parse an input value using one of several patterns.
    
    Parameters:
    
    value - String to parse.
    
    patterns - Patterns to be tried in succession until parsing succeeds.
    
    Returns:
    
    The resulting date value.
    
    Throws:
    
    ParseException - Date parsing exception.
  - cloneDate
```
public static Date cloneDate(Date date)
```
    Clones a date.
    
    Parameters:
    
    date - Date to clone.
    
    Returns:
    
    A clone of the original date, or null if the original date was null.
  - addDays
```
public static Date addDays(Date date,
                           int daysOffset,
                           boolean stripTime)
```
    Adds specified number of days to date and, optionally strips the time component.
    
    Parameters:
    
    date - Date value to process.
    
    daysOffset - # of days to add.
    
    stripTime - If true, strip the time component.
    
    Returns:
    
    Input value the specified operations applied.
  - stripTime
```
public static Date stripTime(Date date)
```
    Strips the time component from a date.
    
    Parameters:
    
    date - Original date.
    
    Returns:
    
    Date without the time component.
  - endOfDay
```
public static Date endOfDay(Date date)
```
    Returns the input date with the time set to the end of the day.
    
    Parameters:
    
    date - Original date.
    
    Returns:
    
    Date with time set to end of day.
  - now
```
public static Date now()
```
    Returns a date with the current time.
    
    Returns:
    
    Current date and time.
  - today
```
public static Date today()
```
    Returns a date with the current day (no time).
    
    Returns:
    
    Current date.
  - compare
```
public static int compare(Date date1,
                          Date date2)
```
    Compares two dates. Allows nulls.
    
    Parameters:
    
    date1 - First date to compare.
    
    date2 - Second date to compare.
    
    Returns:
    
    Result of comparison.
  - formatDate
```
public static String formatDate(Date date)
```
    Converts a date/time value to a string, using the format dd-mmm-yyyy hh:mm. Because we cannot determine the absence of a time from a time of 24:00, we must assume a time of 24:00 means that no time is present and strip that from the return value.
    
    Parameters:
    
    date - Date value to convert.
    
    Returns:
    
    Formatted string representation of the specified date, or an empty string if date is null.
  - formatDate
```
public static String formatDate(Date date,
                                boolean showTimezone)
```
    Converts a date/time value to a string, using the format dd-mmm-yyyy hh:mm. Because we cannot determine the absence of a time from a time of 24:00, we must assume a time of 24:00 means that no time is present and strip that from the return value.
    
    Parameters:
    
    date - Date value to convert.
    
    showTimezone - If true, time zone information is also appended.
    
    Returns:
    
    Formatted string representation of the specified date, or an empty string if date is null.
  - formatDate
```
public static String formatDate(Date date,
                                boolean showTimezone,
                                boolean ignoreTime)
```
    Converts a date/time value to a string, using the format dd-mmm-yyyy hh:mm. Because we cannot determine the absence of a time from a time of 24:00, we must assume a time of 24:00 means that no time is present and strip that from the return value.
    
    Parameters:
    
    date - Date value to convert
    
    showTimezone - If true, time zone information is also appended.
    
    ignoreTime - If true, the time component is ignored.
    
    Returns:
    
    Formatted string representation of the specified date, or an empty string if date is null.
  - formatDate
```
public static String formatDate(Date date,
                                String timeSeparator)
```
    Same as formatDate(Date, boolean) except replaces the time separator with the specified string.
    
    Parameters:
    
    date - Date value to convert
    
    timeSeparator - String to use in place of default time separator
    
    Returns:
    
    Formatted string representation of the specified date using the specified time separator.
  - toHL7
```
public static String toHL7(Date date)
```
    Convert a date to HL7 format.
    
    Parameters:
    
    date - Date to convert.
    
    Returns:
    
    The HL7-formatted date.
  - hasTime
```
public static boolean hasTime(Date date)
```
    Returns true if the date has an associated time.
    
    Parameters:
    
    date - Date value to check.
    
    Returns:
    
    True if the date has a time component.
  - formatElapsed
```
public static String formatElapsed(double elapsed)
```
    Return elapsed time in ms to displayable format with units.
    
    Parameters:
    
    elapsed - Elapsed time in ms.
    
    Returns:
    
    Elapsed time in displayable format.
  - formatElapsed
```
public static String formatElapsed(double elapsed,
                                   DateUtil.TimeUnit minUnits)
```
    Return elapsed time in ms to displayable format with units.
    
    Parameters:
    
    elapsed - Elapsed time in ms.
    
    minUnits - Minimum units for return value (null = ms).
    
    Returns:
    
    Elapsed time in displayable format.
  - formatElapsed
```
public static String formatElapsed(double elapsed,
                                   boolean pluralize,
                                   boolean abbreviated,
                                   boolean round)
```
    Return elapsed time in ms to displayable format with units.
    
    Parameters:
    
    elapsed - Elapsed time in ms.
    
    pluralize - If true, pluralize units when appropriate.
    
    abbreviated - If true, use abbreviated form of units.
    
    round - If true, round result to an integer.
    
    Returns:
    
    Elapsed time in displayable format.
  - formatElapsed
```
public static String formatElapsed(double elapsed,
                                   boolean pluralize,
                                   boolean abbreviated,
                                   boolean round,
                                   DateUtil.TimeUnit minUnits)
```
    Return elapsed time in ms to displayable format with units.
    
    Parameters:
    
    elapsed - Elapsed time in ms.
    
    pluralize - If true, pluralize units when appropriate.
    
    abbreviated - If true, use abbreviated form of units.
    
    round - If true, round result to an integer.
    
    minUnits - Minimum units for return value (null = ms).
    
    Returns:
    
    Elapsed time in displayable format.
  - parseElapsed
```
public static double parseElapsed(String value)
```
    Parses an elapsed time string, returning time in milliseconds.
    
    Parameters:
    
    value - The string value to parse.
    
    Returns:
    
    The elapsed time value in milliseconds.
  - parseElapsed
```
public static double parseElapsed(String value,
                                  DateUtil.TimeUnit units)
```
    Parses an elapsed time string, returning time in specified units.
    
    Parameters:
    
    value - The string value to parse.
    
    units - The units of the returned value (defaults to ms).
    
    Returns:
    
    The elapsed time value in the requested units.
  - formatDuration
```
public static String formatDuration(long duration)
```
    Formats a duration in ms.
    
    Parameters:
    
    duration - Duration in ms.
    
    Returns:
    
    Formatted duration.
  - formatDuration
```
public static String formatDuration(long duration,
                                    DateUtil.TimeUnit accuracy)
```
    Formats a duration in ms to the specified accuracy.
    
    Parameters:
    
    duration - Duration in ms.
    
    accuracy - Accuracy of output.
    
    Returns:
    
    Formatted duration.
  - formatDuration
```
public static String formatDuration(long duration,
                                    DateUtil.TimeUnit accuracy,
                                    boolean pluralize,
                                    boolean abbreviated)
```
    Formats a duration in ms to the specified accuracy.
    
    Parameters:
    
    duration - Duration in ms.
    
    accuracy - Accuracy of output.
    
    pluralize - If true, pluralize units when appropriate.
    
    abbreviated - If true, use abbreviated form of units.
    
    Returns:
    
    Formatted duration.
  - getLocalTimeZone
```
public static TimeZone getLocalTimeZone()
```
    Returns the user's time zone.
    
    Returns:
    
    The user's time zone.
  - formatAge
```
public static String formatAge(Date dob)
```
    Returns age as a formatted string expressed in days, months, or years, depending on whether person is an infant (< 2 mos), toddler (> 2 mos, < 2 yrs), or more than 2 years old.
    
    Parameters:
    
    dob - Date of person's birth
    
    Returns:
    
    the age display string
  - formatAge
```
public static String formatAge(Date dob,
                               boolean pluralize,
                               Date refDate)
```
    Returns age as a formatted string expressed in days, months, or years, depending on whether person is an infant (< 2 mos), toddler (> 2 mos, < 2 yrs), or more than 2 years old.
    
    Allows the caller to specify an "as-of" date. The calculated age will be as-of the provided date, rather than as-of the current date.
    
    Allows the caller to specify whether or not to pluralize the age units in the age display string.
    
    Parameters:
    
    dob - Date of person's birth
    
    pluralize - If true, pluralize the age units in the age display string.
    
    refDate - The date as of which to calculate the Person's age (null means today).
    
    Returns:
    
    the age display string
  - toDate
```
public static Date toDate(int day,
                          int month,
                          int year)
```
    Converts day, month, and year to a date.
    
    Parameters:
    
    day - Day of month.
    
    month - Month (1=January, etc.)
    
    year - Year (4 digit).
    
    Returns:
    
    Date instance.
  - toDate
```
public static Date toDate(int day,
                          int month,
                          int year,
                          int hr,
                          int min,
                          int sec)
```
    Converts day, month, year and time parameters to a date.
    
    Parameters:
    
    day - Day of month.
    
    month - Month (1=January, etc.)
    
    year - Year (4 digit).
    
    hr - Hour of day.
    
    min - Minutes past the hour.
    
    sec - Seconds past the minute.
    
    Returns:
    
    Date instance.

Class DateUtil

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TIME_UNIT

Method Detail

parseDate

parseDate

cloneDate

addDays

stripTime

endOfDay

now

today

compare

formatDate

formatDate

formatDate

formatDate

toHL7

hasTime

formatElapsed

formatElapsed

formatElapsed

formatElapsed

parseElapsed

parseElapsed

formatDuration

formatDuration

formatDuration

getLocalTimeZone

formatAge

formatAge

toDate

toDate