DateTime (Cyclos 4.6 Scripting API Documentation)

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

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_NAME`
`static int`	`MAX_HOUR`
`static int`	`MAX_MILLISECOND`
`static int`	`MAX_MINUTE`
`static int`	`MAX_MONTH`
`static int`	`MAX_SECOND`
`static int`	`MAX_YEAR`

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.
`DateTime(int year, int month, int date, int hours, int minutes, int seconds, int millis, java.lang.String timeZone)` Constructs a `DateTime` with all its fields initialized.
`DateTime(java.lang.String string)`
`DateTime(java.lang.String string, boolean fillToDayEnd)`
`DateTime(java.time.ZonedDateTime zdt)` Constructs a `DateTime` from a `ZonedDateTime`

Method Summary

All Methods Static Methods Instance Methods Concrete 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()`
`java.lang.String`	`getTimeZone()`
`int`	`getYear()`
`int`	`hashCode()`
`DateTime`	`incDate()`
`DateTime`	`incMonth()`
`DateTime`	`incYear()`
`boolean`	`isSameDay(DateTime dt)`
`static DateTime`	`parse(java.lang.String string)` Parses the given String as a `DateTime`, returning null for blank strings
`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`	`setTimeZone(java.lang.String timeZone)`
`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

- Field Detail
  - CLASS_NAME
```
public static final java.lang.String CLASS_NAME
```
  - MAX_YEAR
```
public static final int MAX_YEAR
```
    See Also:
    
    Constant Field Values
  - MAX_MONTH
```
public static final int MAX_MONTH
```
    See Also:
    
    Constant Field Values
  - MAX_HOUR
```
public static final int MAX_HOUR
```
    See Also:
    
    Constant Field Values
  - MAX_MINUTE
```
public static final int MAX_MINUTE
```
    See Also:
    
    Constant Field Values
  - MAX_SECOND
```
public static final int MAX_SECOND
```
    See Also:
    
    Constant Field Values
  - MAX_MILLISECOND
```
public static final int MAX_MILLISECOND
```
    See Also:
    
    Constant Field Values
- 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
  - DateTime
```
public DateTime(int year,
                int month,
                int date,
                int hours,
                int minutes,
                int seconds,
                int millis,
                java.lang.String timeZone)
```
    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
    
    timeZone - the timezone. Null means resolving the current user's configured timezone
  - DateTime
```
public DateTime(java.lang.String string)
```
  - DateTime
```
public DateTime(java.lang.String string,
                boolean fillToDayEnd)
```
  - DateTime
```
public DateTime(java.time.ZonedDateTime zdt)
```
    Constructs a DateTime from a ZonedDateTime
- Method Detail
  - parse
```
public static DateTime parse(java.lang.String string)
```
    Parses the given String as a DateTime, returning null for blank strings
  - 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()
```
  - getTimeZone
```
public java.lang.String getTimeZone()
```
  - 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
  - setTimeZone
```
public void setTimeZone(java.lang.String timeZone)
```
  - 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

Class DateTime

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_NAME

MAX_YEAR

MAX_MONTH

MAX_HOUR

MAX_MINUTE

MAX_SECOND

MAX_MILLISECOND

Constructor Detail

DateTime

DateTime

DateTime

DateTime

DateTime

DateTime

DateTime

DateTime

DateTime

Method Detail

parse

add

after

afterOrEquals

before

beforeOrEquals

compareTo

decDate

decMonth

decYear

duplicate

equals

getDate

getHours

getMilliseconds

getMinutes

getMonth

getSeconds

getTimeZone

getYear

hashCode

incDate

incMonth

incYear

isSameDay

setDate

setHMSM

setHours

setMilliseconds

setMinutes

setMonth

setSeconds

setTimeZone

setYear

setYMD

toString