|
A suite of utilities surrounding the use of the Calendar and Date object. Field Detailpublic static final java.util.TimeZone UTC_TIME_ZONE The UTC time zone (often referred to as GMT). public static final int MILLIS_IN_SECOND Number of milliseconds in a standard second. public static final int MILLIS_IN_MINUTE Number of milliseconds in a standard minute. public static final int MILLIS_IN_HOUR Number of milliseconds in a standard hour. public static final int MILLIS_IN_DAY Number of milliseconds in a standard day. public static final int SEMI_MONTH This is half a month, so this represents whether a date is in the top or bottom half of the month. public static final int RANGE_WEEK_SUNDAY A week range, starting on Sunday. public static final int RANGE_WEEK_MONDAY A week range, starting on Monday. public static final int RANGE_WEEK_RELATIVE A week range, starting on the day focused. public static final int RANGE_WEEK_CENTER A week range, centered around the day focused. public static final int RANGE_MONTH_SUNDAY A month range, the week starting on Sunday. public static final int RANGE_MONTH_MONDAY A month range, the week starting on Monday. Constructor Detailpublic DateUtils() DateUtils instances should NOT be constructed in standard programming. Instead, the class should be used as DateUtils.parse(str);. This constructor is public to permit tools that require a JavaBean instance to operate. Method Detailpublic static java.util.Date round(java.util.Date date, int field) Round this date, leaving the field specified as the most significant field. For example, if you had the datetime of 28 Mar 2002 13:45:01.231, if this was passed with HOUR, it would return 28 Mar 2002 14:00:00.000. If this was passed with MONTH, it would return 1 April 2002 0:00:00.000. Parameters: datethe date to work with fieldthe field from Calendar or SEMI_MONTH Returns: the rounded date Throws: java.lang.IllegalArgumentExceptionif the date is null public static java.util.Calendar round(java.util.Calendar date, int field) Round this date, leaving the field specified as the most significant field. For example, if you had the datetime of 28 Mar 2002 13:45:01.231, if this was passed with HOUR, it would return 28 Mar 2002 14:00:00.000. If this was passed with MONTH, it would return 1 April 2002 0:00:00.000. Parameters: datethe date to work with fieldthe field from Calendar or SEMI_MONTH Returns: the rounded date (a different object) Throws: java.lang.IllegalArgumentExceptionif the date is null public static java.util.Date round(java.lang.Object date, int field) Round this date, leaving the field specified as the most significant field. For example, if you had the datetime of 28 Mar 2002 13:45:01.231, if this was passed with HOUR, it would return 28 Mar 2002 14:00:00.000. If this was passed with MONTH, it would return 1 April 2002 0:00:00.000. Parameters: datethe date to work with, either Date or Calendar fieldthe field from Calendar or SEMI_MONTH Returns: the rounded date Throws: java.lang.IllegalArgumentExceptionif the date is null java.lang.ClassCastExceptionif the object type is not a Date or Calendar public static java.util.Date truncate(java.util.Date date, int field) Truncate this date, leaving the field specified as the most significant field. For example, if you had the datetime of 28 Mar 2002 13:45:01.231, if you passed with HOUR, it would return 28 Mar 2002 13:00:00.000. If this was passed with MONTH, it would return 1 Mar 2002 0:00:00.000. Parameters: datethe date to work with fieldthe field from Calendar or SEMI_MONTH Returns: the rounded date Throws: java.lang.IllegalArgumentExceptionif the date is null public static java.util.Calendar truncate(java.util.Calendar date, int field) Truncate this date, leaving the field specified as the most significant field. For example, if you had the datetime of 28 Mar 2002 13:45:01.231, if you passed with HOUR, it would return 28 Mar 2002 13:00:00.000. If this was passed with MONTH, it would return 1 Mar 2002 0:00:00.000. Parameters: datethe date to work with fieldthe field from Calendar or SEMI_MONTH Returns: the rounded date (a different object) Throws: java.lang.IllegalArgumentExceptionif the date is null public static java.util.Date truncate(java.lang.Object date, int field) Truncate this date, leaving the field specified as the most significant field. For example, if you had the datetime of 28 Mar 2002 13:45:01.231, if you passed with HOUR, it would return 28 Mar 2002 13:00:00.000. If this was passed with MONTH, it would return 1 Mar 2002 0:00:00.000. Parameters: datethe date to work with, either Date or Calendar fieldthe field from Calendar or SEMI_MONTH Returns: the rounded date Throws: java.lang.IllegalArgumentExceptionif the date is null java.lang.ClassCastExceptionif the object type is not a Date or Calendar public static java.util.Iterator iterator(java.util.Date focus, int rangeStyle) This constructs an Iterator that will start and stop over a date range based on the focused date and the range style. For instance, passing Thursday, July 4, 2002 and a RANGE_MONTH_SUNDAY will return an Iterator that starts with Sunday, June 30, 2002 and ends with Saturday, August 3, 2002. Parameters: focusthe date to work with rangeStylethe style constant to use. Must be one of the range styles listed for the iterator(Calendar, int) method. Returns: the date iterator Throws: java.lang.IllegalArgumentExceptionif the date is null or if the rangeStyle is not public static java.util.Iterator iterator(java.util.Calendar focus, int rangeStyle) This constructs an Iterator that will start and stop over a date range based on the focused date and the range style. For instance, passing Thursday, July 4, 2002 and a RANGE_MONTH_SUNDAY will return an Iterator that starts with Sunday, June 30, 2002 and ends with Saturday, August 3, 2002. Parameters: focusthe date to work with rangeStylethe style constant to use. Must be one of RANGE_MONTH_SUNDAY, RANGE_MONTH_MONDAY, RANGE_WEEK_SUNDAY, RANGE_WEEK_MONDAY, RANGE_WEEK_RELATIVE, RANGE_WEEK_CENTER Returns: the date iterator Throws: java.lang.IllegalArgumentExceptionif the date is null public static java.util.Iterator iterator(java.lang.Object focus, int rangeStyle) This constructs an Iterator that will start and stop over a date range based on the focused date and the range style. For instance, passing Thursday, July 4, 2002 and a RANGE_MONTH_SUNDAY will return an Iterator that starts with Sunday, June 30, 2002 and ends with Saturday, August 3, 2002. Parameters: focusthe date to work with, either Date or Calendar rangeStylethe style constant to use. Must be one of the range styles listed for the iterator(Calendar, int) method. Returns: the date iterator Throws: java.lang.IllegalArgumentExceptionif the date is null java.lang.ClassCastExceptionif the object type is not a Date or Calendar |
|