Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> apache >> commons >> lang >> [ time overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.apache.commons.lang.time.DateUtils JAVADOC | Sourc code of org.apache.commons.lang.time.DateUtils SOURCE | Download org.apache.commons.lang.time.DateUtils DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.lang.time
Class DateUtils  view DateUtils download DateUtils.java

java.lang.Object
  extended byorg.apache.commons.lang.time.DateUtils
public class DateUtils
extends java.lang.Object

A suite of utilities surrounding the use of the java.util.Calendar and java.util.Date object.

Since:
2.0
Version:
$Id: DateUtils.java 161243 2005-04-14 04:30:28Z ggregory $

Nested Class Summary
(package private) static class DateUtils.DateIterator
          Date iterator.
 
Field Summary
private static int[][] fields
           
static int MILLIS_IN_DAY
          Deprecated. Use MILLIS_PER_DAY. This will be removed in Commons Lang 3.0.
static int MILLIS_IN_HOUR
          Deprecated. Use MILLIS_PER_HOUR. This will be removed in Commons Lang 3.0.
static int MILLIS_IN_MINUTE
          Deprecated. Use MILLIS_PER_MINUTE. This will be removed in Commons Lang 3.0.
static int MILLIS_IN_SECOND
          Deprecated. Use MILLIS_PER_SECOND. This will be removed in Commons Lang 3.0.
static long MILLIS_PER_DAY
          Number of milliseconds in a standard day.
static long MILLIS_PER_HOUR
          Number of milliseconds in a standard hour.
static long MILLIS_PER_MINUTE
          Number of milliseconds in a standard minute.
static long MILLIS_PER_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 boolean isSameDay(java.util.Calendar cal1, java.util.Calendar cal2)
          Checks if two calendar objects are on the same day ignoring time.
static boolean isSameDay(java.util.Date date1, java.util.Date date2)
          Checks if two date objects are on the same day ignoring time.
static boolean isSameInstant(java.util.Calendar cal1, java.util.Calendar cal2)
          Checks if two calendar objects represent the same instant in time.
static boolean isSameInstant(java.util.Date date1, java.util.Date date2)
          Checks if two date objects represent the same instant in time.
static boolean isSameLocalTime(java.util.Calendar cal1, java.util.Calendar cal2)
          Checks if two calendar objects represent the same local time.
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.
private static void modify(java.util.Calendar val, int field, boolean round)
          Internal calculation method.
static java.util.Date parseDate(java.lang.String str, java.lang.String[] parsePatterns)
          Parses a string representing a date by trying a variety of different parsers.
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

UTC_TIME_ZONE

public static final java.util.TimeZone UTC_TIME_ZONE
The UTC time zone (often referred to as GMT).

MILLIS_PER_SECOND

public static final long MILLIS_PER_SECOND
Number of milliseconds in a standard second.

Since:
2.1
See Also:
Constant Field Values

MILLIS_PER_MINUTE

public static final long MILLIS_PER_MINUTE
Number of milliseconds in a standard minute.

Since:
2.1
See Also:
Constant Field Values

MILLIS_PER_HOUR

public static final long MILLIS_PER_HOUR
Number of milliseconds in a standard hour.

Since:
2.1
See Also:
Constant Field Values

MILLIS_PER_DAY

public static final long MILLIS_PER_DAY
Number of milliseconds in a standard day.

Since:
2.1
See Also:
Constant Field Values

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.

See Also:
Constant Field Values

fields

private static final int[][] fields

RANGE_WEEK_SUNDAY

public static final int RANGE_WEEK_SUNDAY
A week range, starting on Sunday.

See Also:
Constant Field Values

RANGE_WEEK_MONDAY

public static final int RANGE_WEEK_MONDAY
A week range, starting on Monday.

See Also:
Constant Field Values

RANGE_WEEK_RELATIVE

public static final int RANGE_WEEK_RELATIVE
A week range, starting on the day focused.

See Also:
Constant Field Values

RANGE_WEEK_CENTER

public static final int RANGE_WEEK_CENTER
A week range, centered around the day focused.

See Also:
Constant Field Values

RANGE_MONTH_SUNDAY

public static final int RANGE_MONTH_SUNDAY
A month range, the week starting on Sunday.

See Also:
Constant Field Values

RANGE_MONTH_MONDAY

public static final int RANGE_MONTH_MONDAY
A month range, the week starting on Monday.

See Also:
Constant Field Values

MILLIS_IN_SECOND

public static final int MILLIS_IN_SECOND
Deprecated. Use MILLIS_PER_SECOND. This will be removed in Commons Lang 3.0.

Number of milliseconds in a standard second.

See Also:
Constant Field Values

MILLIS_IN_MINUTE

public static final int MILLIS_IN_MINUTE
Deprecated. Use MILLIS_PER_MINUTE. This will be removed in Commons Lang 3.0.

Number of milliseconds in a standard minute.

See Also:
Constant Field Values

MILLIS_IN_HOUR

public static final int MILLIS_IN_HOUR
Deprecated. Use MILLIS_PER_HOUR. This will be removed in Commons Lang 3.0.

Number of milliseconds in a standard hour.

See Also:
Constant Field Values

MILLIS_IN_DAY

public static final int MILLIS_IN_DAY
Deprecated. Use MILLIS_PER_DAY. This will be removed in Commons Lang 3.0.

Number of milliseconds in a standard day.

See Also:
Constant Field Values
Constructor Detail

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.

Method Detail

isSameDay

public static boolean isSameDay(java.util.Date date1,
                                java.util.Date date2)

Checks if two date objects are on the same day ignoring time.

28 Mar 2002 13:45 and 28 Mar 2002 06:01 would return true. 28 Mar 2002 13:45 and 12 Mar 2002 13:45 would return false.

Since:
2.1

isSameDay

public static boolean isSameDay(java.util.Calendar cal1,
                                java.util.Calendar cal2)

Checks if two calendar objects are on the same day ignoring time.

28 Mar 2002 13:45 and 28 Mar 2002 06:01 would return true. 28 Mar 2002 13:45 and 12 Mar 2002 13:45 would return false.

Since:
2.1

isSameInstant

public static boolean isSameInstant(java.util.Date date1,
                                    java.util.Date date2)

Checks if two date objects represent the same instant in time.

This method compares the long millisecond time of the two objects.

Since:
2.1

isSameInstant

public static boolean isSameInstant(java.util.Calendar cal1,
                                    java.util.Calendar cal2)

Checks if two calendar objects represent the same instant in time.

This method compares the long millisecond time of the two objects.

Since:
2.1

isSameLocalTime

public static boolean isSameLocalTime(java.util.Calendar cal1,
                                      java.util.Calendar cal2)

Checks if two calendar objects represent the same local time.

This method compares the values of the fields of the two objects. In addition, both calendars must be the same of the same type.

Since:
2.1

parseDate

public static java.util.Date parseDate(java.lang.String str,
                                       java.lang.String[] parsePatterns)
                                throws java.text.ParseException

Parses a string representing a date by trying a variety of different parsers.

The parse will try each parse pattern in turn. A parse is only deemed sucessful if it parses the whole of the input string. If no parse patterns match, a ParseException is thrown.

round

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.

For a date in a timezone that handles the change to daylight saving time, rounding to Calendar.HOUR_OF_DAY will behave as follows. Suppose daylight saving time begins at 02:00 on March 30. Rounding a date that crosses this time would produce the following values:

  • March 30, 2003 01:10 rounds to March 30, 2003 01:00
  • March 30, 2003 01:40 rounds to March 30, 2003 03:00
  • March 30, 2003 02:10 rounds to March 30, 2003 03:00
  • March 30, 2003 02:40 rounds to March 30, 2003 04:00

round

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.

For a date in a timezone that handles the change to daylight saving time, rounding to Calendar.HOUR_OF_DAY will behave as follows. Suppose daylight saving time begins at 02:00 on March 30. Rounding a date that crosses this time would produce the following values:

  • March 30, 2003 01:10 rounds to March 30, 2003 01:00
  • March 30, 2003 01:40 rounds to March 30, 2003 03:00
  • March 30, 2003 02:10 rounds to March 30, 2003 03:00
  • March 30, 2003 02:40 rounds to March 30, 2003 04:00

round

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.

For a date in a timezone that handles the change to daylight saving time, rounding to Calendar.HOUR_OF_DAY will behave as follows. Suppose daylight saving time begins at 02:00 on March 30. Rounding a date that crosses this time would produce the following values:

  • March 30, 2003 01:10 rounds to March 30, 2003 01:00
  • March 30, 2003 01:40 rounds to March 30, 2003 03:00
  • March 30, 2003 02:10 rounds to March 30, 2003 03:00
  • March 30, 2003 02:40 rounds to March 30, 2003 04:00

truncate

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.

truncate

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.

truncate

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.

modify

private static void modify(java.util.Calendar val,
                           int field,
                           boolean round)

Internal calculation method.

iterator

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.

iterator

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.

iterator

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.

Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> apache >> commons >> lang >> [ time overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.apache.commons.lang.time.DateUtils JAVADOC | Sourc code of org.apache.commons.lang.time.DateUtils SOURCE | Download org.apache.commons.lang.time.DateUtils DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD