IlvCalendarUtil (Rogue Wave JViews 9.2 API)

java.lang.Object
- ilog.views.util.time.IlvCalendarUtil

```
public final class IlvCalendarUtil
extends Object
```
The IlvCalendarUtil class consists of static methods that are of general use when working with Calendar and Date objects. This class is a singleton and instances of this class cannot be created.

Since:

JViews 5.5

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`compareDay(Calendar cal1, Calendar cal2)` Compares the day of two `Calendar`s for order.
`static int`	`compareEra(Calendar cal1, Calendar cal2)` Compares the era (e.g.
`static int`	`compareMonth(Calendar cal1, Calendar cal2)` Compares the month of two `Calendar`s for order.
`static int`	`compareYear(Calendar cal1, Calendar cal2)` Compares the year of two `Calendar`s for order.
`static void`	`dayFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest day boundary.
`static void`	`dayFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest day boundary.
`static int`	`elapsedDays(Calendar cal1, Calendar cal2)` Returns the number of days that have elapsed from one calendar to another.
`static void`	`halfDayFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest half-day or AM-PM boundary.
`static void`	`halfDayFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest half-day or AM-PM boundary.
`static void`	`hourFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest hour boundary.
`static void`	`hourFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest hour boundary.
`static int`	`julianDay(Calendar calendar)` Returns the Julian day number of a date in the given calendar.
`static int`	`julianDay(GregorianCalendar calendar)` Returns the Julian day number of a date in the given `GregorianCalendar`.
`static Date`	`max(Date a, Date b)` Returns the latest time of the 2 values.
`static Date`	`min(Date a, Date b)` Returns the earliest time of the 2 values.
`static void`	`minuteFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest minute boundary.
`static void`	`minuteFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest minute boundary.
`static void`	`monthFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest month boundary.
`static void`	`monthFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest month boundary.
`static void`	`secondFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest second boundary.
`static void`	`secondFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest second boundary.
`static void`	`weekFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest week boundary.
`static void`	`weekFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest week boundary.
`static void`	`yearFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest year boundary.
`static void`	`yearFloor(Calendar calendar)` Truncates the given `Calendar` downwards to the nearest year boundary.

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

- Method Detail
  - min
```
public static Date min(Date a,
                       Date b)
```
    Returns the earliest time of the 2 values.
    
    Parameters:
    
    a - A Date value.
    
    b - A Date value.
    
    Returns:
    
    The earliest of a and b.
  - max
```
public static Date max(Date a,
                       Date b)
```
    Returns the latest time of the 2 values.
    
    Parameters:
    
    a - A Date value.
    
    b - A Date value.
    
    Returns:
    
    The latest of a and b.
  - compareEra
```
public static int compareEra(Calendar cal1,
                             Calendar cal2)
```
    Compares the era (e.g. AD or BC in the Julian calendar) of two Calendars for order. This method returns a negative integer, zero, or a positive integer if the era of the first calendar is before, equal to, or after the era of the second calendar. Both calendars must be of the same class or an IllegalArgumentException will be thrown.
    
    Parameters:
    
    cal1 - The first calendar to be compared.
    
    cal2 - The second calendar to be compared.
    
    Returns:
    
    A negative integer, zero, or a positive integer if the era of cal1 is less than, equal to, or greater than the era of cal2.
    
    Throws:
    
    IllegalArgumentException - if the calendars are of different classes.
  - compareYear
```
public static int compareYear(Calendar cal1,
                              Calendar cal2)
```
    Compares the year of two Calendars for order. This method returns a negative integer, zero, or a positive integer if the year of the first calendar is before, equal to, or after the year of the second calendar. Both calendars must be of the same class or an IllegalArgumentException will be thrown.
    
    Parameters:
    
    cal1 - The first calendar to be compared.
    
    cal2 - The second calendar to be compared.
    
    Returns:
    
    A negative integer, zero, or a positive integer if the year of cal1 is less than, equal to, or greater than the year of cal2.
    
    Throws:
    
    IllegalArgumentException - if the calendars are of different classes.
  - compareMonth
```
public static int compareMonth(Calendar cal1,
                               Calendar cal2)
```
    Compares the month of two Calendars for order. This method returns a negative integer, zero, or a positive integer if the month of the first calendar is before, equal to, or after the month of the second calendar. Both calendars must be of the same class or an IllegalArgumentException will be thrown.
    
    Parameters:
    
    cal1 - The first calendar to be compared.
    
    cal2 - The second calendar to be compared.
    
    Returns:
    
    A negative integer, zero, or a positive integer if the month of cal1 is less than, equal to, or greater than the month of cal2.
    
    Throws:
    
    IllegalArgumentException - if the calendars are of different classes.
  - compareDay
```
public static int compareDay(Calendar cal1,
                             Calendar cal2)
```
    Compares the day of two Calendars for order. This method returns a negative integer, zero, or a positive integer if the day of the first calendar is before, equal to, or after the day of the second calendar. Both calendars must be of the same class or an IllegalArgumentException will be thrown.
    
    Parameters:
    
    cal1 - The first calendar to be compared.
    
    cal2 - The second calendar to be compared.
    
    Returns:
    
    A negative integer, zero, or a positive integer if the day of cal1 is less than, equal to, or greater than the day of cal2.
    
    Throws:
    
    IllegalArgumentException - if the calendars are of different classes.
  - julianDay
```
public static int julianDay(GregorianCalendar calendar)
```
    Returns the Julian day number of a date in the given GregorianCalendar. The Julian day numbering system operates on a 7980 year cycle that considers Jan 1, 4713 B.C. (i.e. -4712-01-01) as its zero point.
    
    It is important to note that a Julian day number is not the same as the Julian calendar. It is also important to note that the GregorianCalendar class is a hybrid calendar that supports both the Julian and Gregorian calendar systems with the support of a single discontinuity. By default, the GregorianCalendar class considers this discontinuity to be October 15, 1582 which is the generally accepted date that changeover was made from the Julian to the Gregorian calendar systems. This method uses the same changeover date in its calculations. This method makes no attempt to take account if the supplied calendar has a non-default changeover date set on it.
    
    Parameters:
    
    calendar - The calendar.
    
    Returns:
    
    The Julian day number of the calendar date.
    
    Since:
    
    JViews 7.5
  - julianDay
```
public static int julianDay(Calendar calendar)
```
    Returns the Julian day number of a date in the given calendar. Julian day numbering only makes sense when using an instance of GregorianCalendar. If the supplied calendar is a different type, this method first converts it to a GregorianCalendar using the default timezone and locale. The Julian day numbering system operates on a 7980 year cycle that considers Jan 1, 4713 B.C. (i.e. -4712-01-01) as its zero point.
    
    It is important to note that a Julian day number is not the same as the Julian calendar. It is also important to note that the GregorianCalendar class is a hybrid calendar that supports both the Julian and Gregorian calendar systems with the support of a single discontinuity. By default, the GregorianCalendar class considers this discontinuity to be October 15, 1582 which is the generally accepted date that changeover was made from the Julian to the Gregorian calendar systems. This method uses the same changeover date in its calculations. This method makes no attempt to take account if the supplied calendar has a non-default changeover date set on it.
    
    Parameters:
    
    calendar - The calendar.
    
    Returns:
    
    The Julian day number of the calendar date.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    julianDay(GregorianCalendar)
  - elapsedDays
```
public static int elapsedDays(Calendar cal1,
                              Calendar cal2)
```
    Returns the number of days that have elapsed from one calendar to another. Both calendars must be of the same class or an IllegalArgumentException will be thrown.
    
    Parameters:
    
    cal1 - The first calendar.
    
    cal2 - The second calendar.
    
    Returns:
    
    The number of days that have elapsed from cal1 to cal2. Zero is returned if the calendars represent the same day.
    
    Throws:
    
    IllegalArgumentException - if the calendars are of different classes.
    
    Since:
    
    JViews 7.5
  - secondFloor
```
public static void secondFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest second boundary.
    
    Parameters:
    
    calendar - The calendar.
  - secondFloor
```
public static void secondFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest second boundary.
    
    Parameters:
    
    calendar - The calendar.
    
    Since:
    
    JViews 8.8
  - minuteFloor
```
public static void minuteFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest minute boundary.
    
    Parameters:
    
    calendar - The calendar.
  - minuteFloor
```
public static void minuteFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest minute boundary.
    
    Parameters:
    
    calendar - The calendar.
    
    Since:
    
    JViews 8.8
  - hourFloor
```
public static void hourFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest hour boundary.
    
    Parameters:
    
    calendar - The calendar.
  - hourFloor
```
public static void hourFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest hour boundary.
    
    Parameters:
    
    calendar - The calendar.
    
    Since:
    
    JViews 8.8
  - halfDayFloor
```
public static void halfDayFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest half-day or AM-PM boundary.
    
    Parameters:
    
    calendar - The calendar.
  - halfDayFloor
```
public static void halfDayFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest half-day or AM-PM boundary.
    
    Parameters:
    
    calendar - The calendar.
    
    Since:
    
    JViews 8.8
  - dayFloor
```
public static void dayFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest day boundary.
    
    Parameters:
    
    calendar - The calendar.
  - dayFloor
```
public static void dayFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest day boundary.
    
    Parameters:
    
    calendar - The calendar.
    
    Since:
    
    JViews 8.8
  - weekFloor
```
public static void weekFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest week boundary.
    
    Parameters:
    
    calendar - The calendar.
  - weekFloor
```
public static void weekFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest week boundary.
    
    Parameters:
    
    calendar - The calendar.
    
    Since:
    
    JViews 8.8
  - monthFloor
```
public static void monthFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest month boundary.
    
    Parameters:
    
    calendar - The calendar.
  - monthFloor
```
public static void monthFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest month boundary.
    
    Parameters:
    
    calendar - The calendar.
    
    Since:
    
    JViews 8.8
  - yearFloor
```
public static void yearFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest year boundary.
    
    Parameters:
    
    calendar - The calendar.
  - yearFloor
```
public static void yearFloor(Calendar calendar)
```
    Truncates the given Calendar downwards to the nearest year boundary.
    
    Parameters:
    
    calendar - The calendar.
    
    Since:
    
    JViews 8.8

Class IlvCalendarUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

min

max

compareEra

compareYear

compareMonth

compareDay

julianDay

julianDay

elapsedDays

secondFloor

secondFloor

minuteFloor

minuteFloor

hourFloor

hourFloor

halfDayFloor

halfDayFloor

dayFloor

dayFloor

weekFloor

weekFloor

monthFloor

monthFloor

yearFloor

yearFloor