|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.lang.time.DateUtils
A suite of utilities surrounding the use of the
Calendar
and Date
object.
Field Summary | |
---|---|
static int |
MILLIS_IN_DAY
Number of milliseconds in a standard day. |
static int |
MILLIS_IN_HOUR
Number of milliseconds in a standard hour. |
static int |
MILLIS_IN_MINUTE
Number of milliseconds in a standard minute. |
static int |
MILLIS_IN_SECOND
Number of milliseconds in a standard second. |
static int |
RANGE_MONTH_MONDAY
A month range, the week starting on Monday. |
static int |
RANGE_MONTH_SUNDAY
A month range, the week starting on Sunday. |
static int |
RANGE_WEEK_CENTER
A week range, centered around the day focused. |
static int |
RANGE_WEEK_MONDAY
A week range, starting on Monday. |
static int |
RANGE_WEEK_RELATIVE
A week range, starting on the day focused. |
static int |
RANGE_WEEK_SUNDAY
A week range, starting on Sunday. |
static int |
SEMI_MONTH
This is half a month, so this represents whether a date is in the top or bottom half of the month. |
static java.util.TimeZone |
UTC_TIME_ZONE
The UTC time zone (often referred to as GMT). |
Constructor Summary | |
---|---|
DateUtils()
DateUtils instances should NOT be constructed in
standard programming. |
Method Summary | |
---|---|
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. |
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. |
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. |
static java.util.Calendar |
round(java.util.Calendar date,
int field)
Round this date, leaving the field specified as the most significant field. |
static java.util.Date |
round(java.util.Date date,
int field)
Round this date, leaving the field specified as the most significant field. |
static java.util.Date |
round(java.lang.Object date,
int field)
Round this date, leaving the field specified as the most significant field. |
static java.util.Calendar |
truncate(java.util.Calendar date,
int field)
Truncate this date, leaving the field specified as the most significant field. |
static java.util.Date |
truncate(java.util.Date date,
int field)
Truncate this date, leaving the field specified as the most significant field. |
static java.util.Date |
truncate(java.lang.Object date,
int field)
Truncate this date, leaving the field specified as the most significant field. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.util.TimeZone UTC_TIME_ZONE
public static final int MILLIS_IN_SECOND
public static final int MILLIS_IN_MINUTE
public static final int MILLIS_IN_HOUR
public static final int MILLIS_IN_DAY
public static final int SEMI_MONTH
public static final int RANGE_WEEK_SUNDAY
public static final int RANGE_WEEK_MONDAY
public static final int RANGE_WEEK_RELATIVE
public static final int RANGE_WEEK_CENTER
public static final int RANGE_MONTH_SUNDAY
public static final int RANGE_MONTH_MONDAY
Constructor Detail |
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.
Method Detail |
public 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.
date
- the date to work withfield
- the field from Calendar
or SEMI_MONTH
java.lang.IllegalArgumentException
- if 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.
date
- the date to work withfield
- the field from Calendar
or SEMI_MONTH
java.lang.IllegalArgumentException
- if 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.
date
- the date to work with, either Date or Calendarfield
- the field from Calendar
or SEMI_MONTH
java.lang.IllegalArgumentException
- if the date is null
java.lang.ClassCastException
- if 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.
date
- the date to work withfield
- the field from Calendar
or SEMI_MONTH
java.lang.IllegalArgumentException
- if 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.
date
- the date to work withfield
- the field from Calendar
or SEMI_MONTH
java.lang.IllegalArgumentException
- if 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.
date
- the date to work with, either Date
or Calendar
field
- the field from Calendar
or SEMI_MONTH
java.lang.IllegalArgumentException
- if the date
is null
java.lang.ClassCastException
- if 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.
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.
java.lang.IllegalArgumentException
- if the date is null
or if
the rangeStyle is notpublic 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.
focus
- the date to work withrangeStyle
- the 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
java.lang.IllegalArgumentException
- if 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.
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.
java.lang.IllegalArgumentException
- if the date
is null
java.lang.ClassCastException
- if the object type is
not a Date
or Calendar
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |