org.cyclos.model.utils

Class DateTime

java.lang.Object

org.cyclos.model.utils.DateTime

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<DateTime>, IDate

public class DateTime
extends java.lang.Object
implements IDate, java.lang.Comparable<DateTime>, java.lang.Cloneable, java.io.Serializable

Mutable class used to represent dates in the Cyclos API instead of Date.
It represents a specific instant in time in a specific time zone (e.g.: the client TZ) with millisecond precision. It works in 'lenient' mode similar to the corresponding Calendar's mode with the difference that for inconsistent fields no exception is thrown.

• Year
• Month (month of year):valid values are in the range 0 (January) - 11 (December)
• Date (day of month): valid values are in the range 1-31
• Hours (hour in day): valid values are in the range 0-23
• Minutes: valid values are in the range 0-59
• Seconds: valid values are in the range 0-59
• Milliseconds: (within the second) valid values are in the range 0-999

Author:

ameyer

See Also:

Formatter.format(DateTime), DateFormat.format(DateTime), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DateTime()
DateTime(int year, int month, int date) Constructs a DateTime with zero in the time fields (HMS).
DateTime(int year, int month, int date, int hours, int minutes) Constructs a DateTime with zero in the time fields (HMS).
DateTime(int year, int month, int date, int hours, int minutes, int seconds) Constructs a DateTime with zero in the time fields (HMS).
DateTime(int year, int month, int date, int hours, int minutes, int seconds, int millis) Constructs a DateTime with all its fields initialized.

Method Summary

Methods

Modifier and Type	Method and Description
DateTime	add(long elapsed) Adds the given number of milliseconds to this date time object
boolean	after(DateTime dt)
boolean	afterOrEquals(DateTime dt)
boolean	before(DateTime dt)
boolean	beforeOrEquals(DateTime dt)
int	compareTo(DateTime dt)
DateTime	decDate()
DateTime	decMonth()
DateTime	decYear()
DateTime	duplicate() Makes a copy of this instance.
boolean	equals(java.lang.Object obj)
int	getDate()
int	getHours()
int	getMilliseconds()
int	getMinutes()
int	getMonth()
int	getSeconds()
int	getYear()
int	hashCode()
DateTime	incDate()
DateTime	incMonth()
DateTime	incYear()
boolean	isSameDay(DateTime dt)
void	setDate(int date) Sets the day of the month.
void	setHMSM(int hours, int minutes, int seconds, int milliseconds) Sets only the time part (H=hours, M=minutes, S=seconds, M=milliseconds) without changing the date part (YMD)
void	setHours(int hours)
void	setMilliseconds(int milliseconds)
void	setMinutes(int minutes)
void	setMonth(int month)
void	setSeconds(int seconds)
void	setYear(int year)
void	setYMD(int year, int month, int date) Sets only the date part (Y=year, M=month, D=date (day of month)) without change the time part (HMS)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DateTime

public DateTime()

DateTime

public DateTime(int year,
        int month,
        int date)

Constructs a DateTime with zero in the time fields (HMS).

Parameters:

month - it must be between 0 and 11 (same as Date)

date - it must be between 1 and 31 (same as Date)

DateTime

public DateTime(int year,
        int month,
        int date,
        int hours,
        int minutes)

Constructs a DateTime with zero in the time fields (HMS).

Parameters:

month - it must be between 0 and 11 (same as Date)

date - it must be between 1 and 31 (same as Date)

hours - it must be between 0 and 23 (Hour in day)

minutes - it must be between 0 and 59

DateTime

public DateTime(int year,
        int month,
        int date,
        int hours,
        int minutes,
        int seconds)

Constructs a DateTime with zero in the time fields (HMS).

Parameters:

month - it must be between 0 and 11 (same as Date)

date - it must be between 1 and 31 (same as Date)

hours - it must be between 0 and 23 (Hour in day)

minutes - it must be between 0 and 59

seconds - it must be between 0 and 59

DateTime

public DateTime(int year,
        int month,
        int date,
        int hours,
        int minutes,
        int seconds,
        int millis)

Constructs a DateTime with all its fields initialized.

Parameters:

month - it must be between 0 and 11 (same as Date)

date - it must be between 1 and 31 (same as Date)

hours - it must be between 0 and 23 (Hour in day)

minutes - it must be between 0 and 59

seconds - it must be between 0 and 59

millis - it must be between 0 and 999

Method Detail

add

public DateTime add(long elapsed)
             throws java.lang.IllegalArgumentException

Adds the given number of milliseconds to this date time object

Returns:

this instance.

Throws:

java.lang.IllegalArgumentException - if elapsed time is negative.

after

public boolean after(DateTime dt)

afterOrEquals

public boolean afterOrEquals(DateTime dt)

before

public boolean before(DateTime dt)

beforeOrEquals

public boolean beforeOrEquals(DateTime dt)

compareTo

public int compareTo(DateTime dt)

Specified by:

compareTo in interface java.lang.Comparable<DateTime>

decDate

public DateTime decDate()

decMonth

public DateTime decMonth()

decYear

public DateTime decYear()

duplicate

public DateTime duplicate()

Makes a copy of this instance.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getDate

public int getDate()

getHours

public int getHours()

getMilliseconds

public int getMilliseconds()

getMinutes

public int getMinutes()

getMonth

public int getMonth()

getSeconds

public int getSeconds()

getYear

public int getYear()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

incDate

public DateTime incDate()

incMonth

public DateTime incMonth()

incYear

public DateTime incYear()

isSameDay

public boolean isSameDay(DateTime dt)

setDate

public void setDate(int date)

Sets the day of the month.

Parameters:

date - it must be between 1 and 31 (must be a valid value according to the month)

setHMSM

public void setHMSM(int hours,
           int minutes,
           int seconds,
           int milliseconds)

Sets only the time part (H=hours, M=minutes, S=seconds, M=milliseconds) without changing the date part (YMD)

Parameters:

hours - it must be between 0 and 23 (Hour in day)

setHours

public void setHours(int hours)

Parameters:

hours - it must be between 0 and 23 (Hour in day)

setMilliseconds

public void setMilliseconds(int milliseconds)

setMinutes

public void setMinutes(int minutes)

Parameters:

minutes - it must be between 0 and 59

setMonth

public void setMonth(int month)

Parameters:

month - it must be between 0 and 11 (same as Date)

setSeconds

public void setSeconds(int seconds)

Parameters:

seconds - it must be between 0 and 59

setYear

public void setYear(int year)

setYMD

public void setYMD(int year,
          int month,
          int date)

Sets only the date part (Y=year, M=month, D=date (day of month)) without change the time part (HMS)

Parameters:

month - it must be between 0 and 11 (same as Date)

date - it must be between 1 and 31 (same as Date)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object