org.apache.commons.lang.time
Class DateUtils
A suite of utilities surrounding the use of the
Calendar
and
Date
object.
$Id: DateUtils.java,v 1.16 2003/08/18 21:52:39 ggregory Exp $
DateUtils() -
DateUtils instances should NOT be constructed in
standard programming.
|
static Iterator | iterator(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.
|
static Iterator | iterator(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.
|
static Iterator | iterator(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.
|
static Calendar | round(Calendar date, int field) - Round this date, leaving the field specified as the most
significant field.
|
static Date | round(Date date, int field) - Round this date, leaving the field specified as the most
significant field.
|
static Date | round(Object date, int field) - Round this date, leaving the field specified as the most
significant field.
|
static Calendar | truncate(Calendar date, int field) - Truncate this date, leaving the field specified as the most
significant field.
|
static Date | truncate(Date date, int field) - Truncate this date, leaving the field specified as the most
significant field.
|
static Date | truncate(Object date, int field) - Truncate this date, leaving the field specified as the most
significant field.
|
MILLIS_IN_DAY
public static final int MILLIS_IN_DAY
Number of milliseconds in a standard day.
MILLIS_IN_HOUR
public static final int MILLIS_IN_HOUR
Number of milliseconds in a standard hour.
MILLIS_IN_MINUTE
public static final int MILLIS_IN_MINUTE
Number of milliseconds in a standard minute.
MILLIS_IN_SECOND
public static final int MILLIS_IN_SECOND
Number of milliseconds in a standard second.
RANGE_MONTH_MONDAY
public static final int RANGE_MONTH_MONDAY
A month range, the week starting on Monday.
RANGE_MONTH_SUNDAY
public static final int RANGE_MONTH_SUNDAY
A month range, the week starting on Sunday.
RANGE_WEEK_CENTER
public static final int RANGE_WEEK_CENTER
A week range, centered around the day focused.
RANGE_WEEK_MONDAY
public static final int RANGE_WEEK_MONDAY
A week range, starting on Monday.
RANGE_WEEK_RELATIVE
public static final int RANGE_WEEK_RELATIVE
A week range, starting on the day focused.
RANGE_WEEK_SUNDAY
public static final int RANGE_WEEK_SUNDAY
A week range, starting on Sunday.
SEMI_MONTH
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.
UTC_TIME_ZONE
public static final TimeZone UTC_TIME_ZONE
The UTC time zone (often referred to as GMT).
DateUtils
public 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.
iterator
public static Iterator iterator(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.
iterator
public static Iterator iterator(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.
focus
- the date to work withrangeStyle
- the style constant to use. Must be one of the range
styles listed for the iterator(Calendar,int)
method.
iterator
public static Iterator iterator(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.
focus
- the date to work with, either
Date
or Calendar
rangeStyle
- the style constant to use. Must be one of the range
styles listed for the iterator(Calendar,int)
method.
round
public static Calendar round(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.
date
- the date to work withfield
- the field from Calendar
or SEMI_MONTH
- the rounded date (a different object)
round
public static Date round(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.
date
- the date to work withfield
- the field from Calendar
or SEMI_MONTH
round
public static Date round(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.
date
- the date to work with, either Date or Calendarfield
- the field from Calendar
or SEMI_MONTH
truncate
public static Calendar truncate(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.
date
- the date to work withfield
- the field from Calendar
or SEMI_MONTH
- the rounded date (a different object)
truncate
public static Date truncate(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.
date
- the date to work withfield
- the field from Calendar
or SEMI_MONTH
truncate
public static Date truncate(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.
date
- the date to work with, either Date
or Calendar
field
- the field from Calendar
or SEMI_MONTH
Copyright © 2001-2003 - Apache Software Foundation