Interval (CalendarFX API)

java.lang.Object
- com.calendarfx.model.Interval

```
public final class Interval
extends Object
```
A class used for storing the time interval and time zone of an entry.

See Also:

Entry.setInterval(Interval)

Constructor Summary

Constructors
Constructor and Description
`Interval()` Constructs a new time interval with start and end dates equal to `LocalDate.now()`.
`Interval(LocalDate startDate, LocalTime startTime, LocalDate endDate, LocalTime endTime)` Constructs a new time interval with the given start and end dates / times.
`Interval(LocalDate startDate, LocalTime startTime, LocalDate endDate, LocalTime endTime, ZoneId zoneId)` Constructs a new time interval with the given start and end dates / times and time zone.
`Interval(LocalDateTime startDateTime, LocalDateTime endDateTime)` Constructs a new time interval with the given start and end dates / times.
`Interval(LocalDateTime startDateTime, LocalDateTime endDateTime, ZoneId zoneId)` Constructs a new time interval with the given start and end dates / times and time zone.
`Interval(ZonedDateTime zonedStartDateTime, ZonedDateTime zonedEndDateTime)` Constructs a new time interval with the given start and end zoned dates / times.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Duration`	`getDuration()` Returns the duration of this interval.
`LocalDate`	`getEndDate()` Returns the end date of the interval.
`LocalDateTime`	`getEndDateTime()` Utility method to get the local end date time.
`long`	`getEndMillis()` Returns the start time in milliseconds since 1.1.1970.
`LocalTime`	`getEndTime()` Returns the end time of the interval.
`ZonedDateTime`	`getEndZonedDateTime()` A convenience method to retrieve a zoned date time based on the end date, end time, and time zone id.
`LocalDate`	`getStartDate()` Returns the start date of the interval.
`LocalDateTime`	`getStartDateTime()` Utility method to get the local start date time.
`long`	`getStartMillis()` Returns the start time in milliseconds since 1.1.1970.
`LocalTime`	`getStartTime()` Returns the start time of the interval.
`ZonedDateTime`	`getStartZonedDateTime()` A convenience method to retrieve a zoned date time based on the start date, start time, and time zone id.
`ZoneId`	`getZoneId()` Returns the time zone ID.
`int`	`hashCode()`
`String`	`toString()`
`Interval`	`withDates(LocalDate startDate, LocalDate endDate)` Returns a new interval based on this interval but with a different start and end date.
`Interval`	`withDates(LocalDateTime startDateTime, LocalDateTime endDateTime)` Returns a new interval based on this interval but with a different start and end date.
`Interval`	`withEndDate(LocalDate date)` Returns a new interval based on this interval but with a different end date.
`Interval`	`withEndDateTime(LocalDateTime dateTime)` Returns a new interval based on this interval but with a different end date and time.
`Interval`	`withEndTime(LocalTime time)` Returns a new interval based on this interval but with a different end time.
`Interval`	`withStartDate(LocalDate date)` Returns a new interval based on this interval but with a different start date.
`Interval`	`withStartDateTime(LocalDateTime dateTime)` Returns a new interval based on this interval but with a different start date and time.
`Interval`	`withStartTime(LocalTime time)` Returns a new interval based on this interval but with a different start time.
`Interval`	`withTimes(LocalTime startTime, LocalTime endTime)` Returns a new interval based on this interval but with a different start and end time.
`Interval`	`withZoneId(ZoneId zone)` Returns a new interval based on this interval but with a different time zone id.

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

- Constructor Detail
  - Interval
```
public Interval()
```
    Constructs a new time interval with start and end dates equal to LocalDate.now(). The start and end times will be set to LocalTime.now() and LocalTime.now() plus one hour. The time zone will be set to ZoneId.systemDefault().
  - Interval
```
public Interval(LocalDate startDate,
                LocalTime startTime,
                LocalDate endDate,
                LocalTime endTime)
```
    Constructs a new time interval with the given start and end dates / times. The time zone will be initialized with ZoneId.systemDefault().
    
    Parameters:
    
    startDate - the start date (e.g. Oct. 3rd, 2015)
    
    startTime - the start time (e.g. 10:45am)
    
    endDate - the end date
    
    endTime - the end time
  - Interval
```
public Interval(LocalDateTime startDateTime,
                LocalDateTime endDateTime)
```
    Constructs a new time interval with the given start and end dates / times. The time zone will be initialized with ZoneId.systemDefault().
    
    Parameters:
    
    startDateTime - the start date and time (e.g. Oct. 3rd, 2015, 6:15pm)
    
    endDateTime - the end date and time
  - Interval
```
public Interval(ZonedDateTime zonedStartDateTime,
                ZonedDateTime zonedEndDateTime)
```
    Constructs a new time interval with the given start and end zoned dates / times. The time zone will be initialized with the time zone of the start date time. However, if the zone ID of the second argument is different then an exception will be thrown.
    
    Parameters:
    
    zonedStartDateTime - the start date and time (e.g. Oct. 3rd, 2015, 6:15pm)
    
    zonedEndDateTime - the end date and time
    
    Throws:
    
    IllegalArgumentException - if two different time zones are used
  - Interval
```
public Interval(LocalDateTime startDateTime,
                LocalDateTime endDateTime,
                ZoneId zoneId)
```
    Constructs a new time interval with the given start and end dates / times and time zone.
    
    Parameters:
    
    startDateTime - the start date and time (e.g. Oct. 3rd, 2015, 6:15pm)
    
    endDateTime - the end date and time
    
    zoneId - the time zone
  - Interval
```
public Interval(LocalDate startDate,
                LocalTime startTime,
                LocalDate endDate,
                LocalTime endTime,
                ZoneId zoneId)
```
    Constructs a new time interval with the given start and end dates / times and time zone.
    
    Parameters:
    
    startDate - the start date (e.g. Oct. 3rd, 2015)
    
    startTime - the start time (e.g. 10:45am)
    
    endDate - the end date
    
    endTime - the end time
    
    zoneId - the time zone
- Method Detail
  - getZoneId
```
public ZoneId getZoneId()
```
    Returns the time zone ID.
    
    Returns:
    
    the time zone
  - getStartDate
```
public LocalDate getStartDate()
```
    Returns the start date of the interval.
    
    Returns:
    
    the start date
  - getStartTime
```
public LocalTime getStartTime()
```
    Returns the start time of the interval.
    
    Returns:
    
    the start time
  - getStartZonedDateTime
```
public ZonedDateTime getStartZonedDateTime()
```
    A convenience method to retrieve a zoned date time based on the start date, start time, and time zone id.
    
    Returns:
    
    the zoned start time
  - getStartMillis
```
public long getStartMillis()
```
    Returns the start time in milliseconds since 1.1.1970.
    
    Returns:
    
    the start time in milliseconds
  - getEndDate
```
public LocalDate getEndDate()
```
    Returns the end date of the interval.
    
    Returns:
    
    the end date
  - getEndTime
```
public LocalTime getEndTime()
```
    Returns the end time of the interval.
    
    Returns:
    
    the end time
  - getEndZonedDateTime
```
public ZonedDateTime getEndZonedDateTime()
```
    A convenience method to retrieve a zoned date time based on the end date, end time, and time zone id.
    
    Returns:
    
    the zoned end time
  - getEndMillis
```
public long getEndMillis()
```
    Returns the start time in milliseconds since 1.1.1970.
    
    Returns:
    
    the start time in milliseconds
  - withDates
```
public Interval withDates(LocalDate startDate,
                          LocalDate endDate)
```
    Returns a new interval based on this interval but with a different start and end date.
    
    Parameters:
    
    startDate - the new start date
    
    endDate - the new end date
    
    Returns:
    
    a new interval
  - withDates
```
public Interval withDates(LocalDateTime startDateTime,
                          LocalDateTime endDateTime)
```
    Returns a new interval based on this interval but with a different start and end date.
    
    Parameters:
    
    startDateTime - the new start date
    
    endDateTime - the new end date
    
    Returns:
    
    a new interval
  - withTimes
```
public Interval withTimes(LocalTime startTime,
                          LocalTime endTime)
```
    Returns a new interval based on this interval but with a different start and end time.
    
    Parameters:
    
    startTime - the new start time
    
    endTime - the new end time
    
    Returns:
    
    a new interval
  - withStartDate
```
public Interval withStartDate(LocalDate date)
```
    Returns a new interval based on this interval but with a different start date.
    
    Parameters:
    
    date - the new start date
    
    Returns:
    
    a new interval
  - withEndDate
```
public Interval withEndDate(LocalDate date)
```
    Returns a new interval based on this interval but with a different end date.
    
    Parameters:
    
    date - the new end date
    
    Returns:
    
    a new interval
  - withStartTime
```
public Interval withStartTime(LocalTime time)
```
    Returns a new interval based on this interval but with a different start time.
    
    Parameters:
    
    time - the new start time
    
    Returns:
    
    a new interval
  - withStartDateTime
```
public Interval withStartDateTime(LocalDateTime dateTime)
```
    Returns a new interval based on this interval but with a different start date and time.
    
    Parameters:
    
    dateTime - the new start date and time
    
    Returns:
    
    a new interval
  - withEndTime
```
public Interval withEndTime(LocalTime time)
```
    Returns a new interval based on this interval but with a different end time.
    
    Parameters:
    
    time - the new end time
    
    Returns:
    
    a new interval
  - withEndDateTime
```
public Interval withEndDateTime(LocalDateTime dateTime)
```
    Returns a new interval based on this interval but with a different end date and time.
    
    Parameters:
    
    dateTime - the new end date and time
    
    Returns:
    
    a new interval
  - withZoneId
```
public Interval withZoneId(ZoneId zone)
```
    Returns a new interval based on this interval but with a different time zone id.
    
    Parameters:
    
    zone - the new time zone
    
    Returns:
    
    a new interval
  - getStartDateTime
```
public LocalDateTime getStartDateTime()
```
    Utility method to get the local start date time. This method combines the start date and the start time to create a date time object.
    
    Returns:
    
    the start local date time
    
    See Also:
    
    getStartDate(), getStartTime()
  - getDuration
```
public Duration getDuration()
```
    Returns the duration of this interval.
    
    Returns:
    
    the duration between the zoned start and end date and time
  - getEndDateTime
```
public LocalDateTime getEndDateTime()
```
    Utility method to get the local end date time. This method combines the end date and the end time to create a date time object.
    
    Returns:
    
    the end local date time
    
    See Also:
    
    getEndDate(), getEndTime()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Interval

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Interval

Interval

Interval

Interval

Interval

Interval

Method Detail

getZoneId

getStartDate

getStartTime

getStartZonedDateTime

getStartMillis

getEndDate

getEndTime

getEndZonedDateTime

getEndMillis

withDates

withDates

withTimes

withStartDate

withEndDate

withStartTime

withStartDateTime

withEndTime

withEndDateTime

withZoneId

getStartDateTime

getDuration

getEndDateTime

hashCode

equals

toString