RubyDate

java.lang.Object
- java.util.Date
- - net.sf.rubycollect4j.RubyDate

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<java.util.Date>
```
public final class RubyDate
extends java.util.Date
```
RubyDate simply extends Java Date and adds few useful methods which are inspired by Ruby on Rails.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RubyDate.DateField` `RubyDate.DateField` is designed for `change(Map)` to use.
`class`	`RubyDate.DateShifter` `RubyDate.DateShifter` shifts a Date by an interval of time and creates a new `RubyDate` from it.

Constructor Summary

Constructors
Constructor and Description

RubyDate()
Returns a RubyDate of now.

RubyDate(java.util.Date date)
Creates a RubyDate of given Date.

Constructors
Constructor and Description
`RubyDate()` Returns a `RubyDate` of now.
`RubyDate(java.util.Date date)` Creates a `RubyDate` of given Date.

Method Summary

Methods
Modifier and Type	Method and Description
`RubyDate.DateShifter`	`add(int interval)` Increases an interval of time to a date by the `RubyDate.DateShifter`.
`RubyDate`	`beginningOfDay()` Returns a new `RubyDate` with time set to the beginning of day based on this `RubyDate`.
`RubyDate`	`beginningOfMonth()` Returns a new `RubyDate` with time set to the beginning of month based on this `RubyDate`.
`RubyDate`	`beginningOfQuarter()` Returns a new `RubyDate` representing the start of the quarter (1st of january, april, july, october).
`RubyDate`	`beginningOfWeek()` Returns a new `RubyDate` with time set to the beginning of week based on this `RubyDate`.
`RubyDate`	`beginningOfYear()` Returns a new `RubyDate` representing the beginning of the year.
`RubyDate`	`change(java.util.Map<RubyDate.DateField,java.lang.Integer> options)` Returns a new `RubyDate` where one or more of the elements have been changed according to the options parameter.
`static RubyDate`	`current()` Creates a `RubyDate` of current time.
`int`	`day()` Returns the day(1-31) of this `RubyDate`.
`int`	`dayOfMonth()` Returns the day(1-31) of month of this `RubyDate`.
`int`	`dayOfWeek()` Returns the day(0-6) of week of this `RubyDate`. Sun : 0 Mon : 1 Tue : 2 Wed : 3 Thur: 4 Fri : 5 Sat : 6
`int`	`dayOfYear()` Returns the day of year of this `RubyDate`.
`RubyDate`	`endOfDay()` Returns a new `RubyDate` with time set to the end of day based on this `RubyDate`.
`RubyDate`	`endOfMonth()` Returns a new `RubyDate` with time set to the end of month based on this `RubyDate`.
`RubyDate`	`endOfQuarter()` Returns a new `RubyDate` representing the end of the quarter (last day of march, june, september, december).
`RubyDate`	`endOfWeek()` Returns a new `RubyDate` with time set to the end of week based on this `RubyDate`.
`RubyDate`	`endOfYear()` Returns a new `RubyDate` representing the end of the year.
`boolean`	`futureʔ()` Checks if this `RubyDate` represents a future time.
`int`	`hour()` Returns the hour(0-23) of this `RubyDate`.
`int`	`millisecond()` Returns the millisecond of this `RubyDate`.
`RubyDate.DateShifter`	`minus(int interval)` Decreases an interval of time to a date by the `RubyDate.DateShifter`.
`int`	`minute()` Returns the minute of this `RubyDate`.
`int`	`month()` Returns the month(1-12) of this `RubyDate`.
`boolean`	`pastʔ()` Checks if this `RubyDate` represents a past time.
`int`	`second()` Returns the second of this `RubyDate`.
`static RubyDate`	`today()` Creates a `RubyDate` of beginning of today.
`boolean`	`todayʔ()` Checks if this `RubyDate` is a time of today.
`static RubyDate`	`tomorrow()` Creates a `RubyDate` of tomorrow.
`int`	`week()` Returns the week of year of this `RubyDate`.
`int`	`weekOfMonth()` Returns the week of month of this `RubyDate`.
`int`	`year()` Returns the year of this `RubyDate`.
`static RubyDate`	`yesterday()` Creates a `RubyDate` of yesterday.

Methods inherited from class java.util.Date
after, before, clone, compareTo, equals, getDate, getDay, getHours, getMinutes, getMonth, getSeconds, getTime, getTimezoneOffset, getYear, hashCode, parse, setDate, setHours, setMinutes, setMonth, setSeconds, setTime, setYear, toGMTString, toLocaleString, toString, UTC

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RubyDate
```
public RubyDate()
```
    Returns a RubyDate of now.
  - RubyDate
```
public RubyDate(java.util.Date date)
```
    Creates a RubyDate of given Date.
    
    Parameters:
    date - a Date
    
    Throws:
    
    java.lang.NullPointerException - if date is null
- Method Detail
  - change
```
public RubyDate change(java.util.Map<RubyDate.DateField,java.lang.Integer> options)
```
    Returns a new RubyDate where one or more of the elements have been changed according to the options parameter.
    
    Returns:
    new RubyDate
  - year
```
public int year()
```
    Returns the year of this RubyDate.
    
    Returns:
    the year
  - month
```
public int month()
```
    Returns the month(1-12) of this RubyDate.
    
    Returns:
    the month
  - day
```
public int day()
```
    Returns the day(1-31) of this RubyDate.
    
    Returns:
    the day
  - dayOfWeek
```
public int dayOfWeek()
```
    Returns the day(0-6) of week of this RubyDate.
    Sun : 0
    Mon : 1
    Tue : 2
    Wed : 3
    Thur: 4
    Fri : 5
    Sat : 6
    
    Returns:
    the day of week
  - dayOfMonth
```
public int dayOfMonth()
```
    Returns the day(1-31) of month of this RubyDate.
    
    Returns:
    the day of month
  - dayOfYear
```
public int dayOfYear()
```
    Returns the day of year of this RubyDate.
    
    Returns:
    the day of year
  - week
```
public int week()
```
    Returns the week of year of this RubyDate.
    
    Returns:
    the week of year
  - weekOfMonth
```
public int weekOfMonth()
```
    Returns the week of month of this RubyDate.
    
    Returns:
    the week of month
  - hour
```
public int hour()
```
    Returns the hour(0-23) of this RubyDate.
    
    Returns:
    the hour
  - minute
```
public int minute()
```
    Returns the minute of this RubyDate.
    
    Returns:
    the minute
  - second
```
public int second()
```
    Returns the second of this RubyDate.
    
    Returns:
    the second
  - millisecond
```
public int millisecond()
```
    Returns the millisecond of this RubyDate.
    
    Returns:
    the millisecond
  - add
```
public RubyDate.DateShifter add(int interval)
```
    Increases an interval of time to a date by the RubyDate.DateShifter.
    
    Parameters:
    interval - of time to be shifted
    
    Returns:
    RubyDate.DateShifter
  - minus
```
public RubyDate.DateShifter minus(int interval)
```
    Decreases an interval of time to a date by the RubyDate.DateShifter.
    
    Parameters:
    interval - of time to be shifted
    
    Returns:
    RubyDate.DateShifter
  - beginningOfDay
```
public RubyDate beginningOfDay()
```
    Returns a new RubyDate with time set to the beginning of day based on this RubyDate.
    
    Returns:
    new RubyDate
  - endOfDay
```
public RubyDate endOfDay()
```
    Returns a new RubyDate with time set to the end of day based on this RubyDate.
    
    Returns:
    new RubyDate
  - beginningOfWeek
```
public RubyDate beginningOfWeek()
```
    Returns a new RubyDate with time set to the beginning of week based on this RubyDate. The beginning of week is Sunday.
    
    Returns:
    new RubyDate
  - endOfWeek
```
public RubyDate endOfWeek()
```
    Returns a new RubyDate with time set to the end of week based on this RubyDate. The end of week is Saturday.
    
    Returns:
    new RubyDate
  - beginningOfMonth
```
public RubyDate beginningOfMonth()
```
    Returns a new RubyDate with time set to the beginning of month based on this RubyDate.
    
    Returns:
    new RubyDate
  - endOfMonth
```
public RubyDate endOfMonth()
```
    Returns a new RubyDate with time set to the end of month based on this RubyDate.
    
    Returns:
    new RubyDate
  - beginningOfQuarter
```
public RubyDate beginningOfQuarter()
```
    Returns a new RubyDate representing the start of the quarter (1st of january, april, july, october).
    
    Returns:
    new RubyDate
  - endOfQuarter
```
public RubyDate endOfQuarter()
```
    Returns a new RubyDate representing the end of the quarter (last day of march, june, september, december).
    
    Returns:
    new RubyDate
  - beginningOfYear
```
public RubyDate beginningOfYear()
```
    Returns a new RubyDate representing the beginning of the year.
    
    Returns:
    new RubyDate
  - endOfYear
```
public RubyDate endOfYear()
```
    Returns a new RubyDate representing the end of the year.
    
    Returns:
    new RubyDate
  - futureʔ
```
public boolean futureʔ()
```
    Checks if this RubyDate represents a future time.
    
    Returns:
    true if this RubyDate represents a future time, false otherwise
  - pastʔ
```
public boolean pastʔ()
```
    Checks if this RubyDate represents a past time.
    
    Returns:
    true if this RubyDate represents a past time, false otherwise
  - todayʔ
```
public boolean todayʔ()
```
    Checks if this RubyDate is a time of today.
    
    Returns:
    true if this RubyDate is a time of today, false otherwise
  - current
```
public static RubyDate current()
```
    Creates a RubyDate of current time.
    
    Returns:
    RubyDate
  - today
```
public static RubyDate today()
```
    Creates a RubyDate of beginning of today.
    
    Returns:
    RubyDate
  - tomorrow
```
public static RubyDate tomorrow()
```
    Creates a RubyDate of tomorrow.
    
    Returns:
    RubyDate
  - yesterday
```
public static RubyDate yesterday()
```
    Creates a RubyDate of yesterday.
    
    Returns:
    RubyDate

Class RubyDate

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.Date

Methods inherited from class java.lang.Object

Constructor Detail

RubyDate

RubyDate

Method Detail

change

year

month

day

dayOfWeek

dayOfMonth

dayOfYear

week

weekOfMonth

hour

minute

second

millisecond

add

minus

beginningOfDay

endOfDay

beginningOfWeek

endOfWeek

beginningOfMonth

endOfMonth

beginningOfQuarter

endOfQuarter

beginningOfYear

endOfYear

futureʔ

pastʔ

todayʔ

current

today

tomorrow

yesterday