Class DateInterval
Inherited Members
Namespace: NodaTime
Assembly: NodaTime.dll
Syntax
public sealed class DateInterval : IEquatable<DateInterval>, IEnumerable<LocalDate>, IEnumerable
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
Constructors
DateInterval(LocalDate, LocalDate)
Declaration
public DateInterval(LocalDate start, LocalDate end)
Parameters
Type | Name | Description |
---|---|---|
LocalDate | start | Start date of the interval |
LocalDate | end | End date of the interval |
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
Sample snippet
using NodaTime;
using System;
var calendar = CalendarSystem.Gregorian;
LocalDate start = new LocalDate(2017, 1, 1, calendar);
LocalDate end = new LocalDate(2017, 12, 31, calendar);
DateInterval interval = new DateInterval(start, end);
Console.WriteLine(interval.Length);
Console.WriteLine(interval.ToString());
Console.WriteLine(interval.Start);
Console.WriteLine(interval.End);
Console.WriteLine(interval.Calendar);
Output:
365
[2017-01-01, 2017-12-31]
Sunday, 01 January 2017
Sunday, 31 December 2017
Gregorian
Exceptions
Type | Condition |
---|---|
ArgumentException | end is earlier than start
or the two dates are in different calendars.
|
Properties
Calendar
Declaration
public CalendarSystem Calendar { get; }
Property Value
Type | Description |
---|---|
CalendarSystem | The calendar system of the dates in this interval. (The value returned is never null.) |
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
End
Declaration
public LocalDate End { get; }
Property Value
Type | Description |
---|---|
LocalDate | The end date of the interval. |
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
Length
Declaration
public int Length { get; }
Property Value
Type | Description |
---|---|
Int32 | The length of this date interval in days. |
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
Start
Declaration
public LocalDate Start { get; }
Property Value
Type | Description |
---|---|
LocalDate | The start date of the interval. |
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
Methods
Contains(DateInterval)
Declaration
public bool Contains(DateInterval interval)
Parameters
Type | Name | Description |
---|---|---|
DateInterval | interval | The interval to check for containment within this interval. |
Returns
Type | Description |
---|---|
Boolean | true if interval is within this interval; false otherwise. |
Remarks
Sample snippet
using NodaTime;
using System;
LocalDate start = new LocalDate(2017, 1, 1);
LocalDate end = new LocalDate(2017, 12, 31);
DateInterval interval = new DateInterval(start, end);
DateInterval june = new DateInterval(
new LocalDate(2017, 6, 1),
new LocalDate(2017, 6, 30));
var result = interval.Contains(june);
Console.WriteLine(result);
Output:
True
Exceptions
Type | Condition |
---|---|
ArgumentException | interval uses a different
calendar to this date interval. |
ArgumentNullException | interval is null. |
Contains(LocalDate)
Declaration
public bool Contains(LocalDate date)
Parameters
Type | Name | Description |
---|---|---|
LocalDate | date | The date to check for containment within this interval. |
Returns
Type | Description |
---|---|
Boolean | true if date is within this interval; false otherwise. |
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
Sample snippet
using NodaTime;
using System;
LocalDate start = new LocalDate(2017, 1, 1);
LocalDate end = new LocalDate(2017, 12, 31);
DateInterval interval = new DateInterval(start, end);
var result = interval.Contains(new LocalDate(2017, 12, 5));
Console.WriteLine(result);
Output:
True
Exceptions
Type | Condition |
---|---|
ArgumentException | date is not in the same
calendar as the start and end date of this interval. |
Deconstruct(out LocalDate, out LocalDate)
Declaration
public void Deconstruct(out LocalDate start, out LocalDate end)
Parameters
Type | Name | Description |
---|---|---|
LocalDate | start | The LocalDate representing the start of the interval. |
LocalDate | end | The LocalDate representing the end of the interval. |
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
Equals(DateInterval)
Declaration
public bool Equals(DateInterval other)
Parameters
Type | Name | Description |
---|---|---|
DateInterval | other | The date interval to compare this one with. |
Returns
Type | Description |
---|---|
Boolean | True if this date interval has the same same start and end date as the one specified. |
Remarks
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
Object | obj | The value to compare this one with. |
Returns
Type | Description |
---|---|
Boolean | true if the other object is a date interval equal to this one, consistent with Equals(DateInterval). |
Overrides
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
GetEnumerator()
Declaration
public IEnumerator<LocalDate> GetEnumerator()
Returns
Type | Description |
---|---|
IEnumerator<LocalDate> | An enumerator for the interval. (The value returned is never null.) |
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
Int32 | The hash code for this interval. |
Overrides
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
Intersection(DateInterval)
Declaration
public DateInterval Intersection(DateInterval interval)
Parameters
Type | Name | Description |
---|---|---|
DateInterval | interval | The specified interval to intersect with this one. |
Returns
Type | Description |
---|---|
DateInterval | A DateInterval corresponding to the intersection between the given interval and the current instance. If there is no intersection, a null reference is returned. |
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
Sample snippet
using NodaTime;
using System;
DateInterval januaryToAugust = new DateInterval(
new LocalDate(2017, 1, 1),
new LocalDate(2017, 8, 31));
DateInterval juneToNovember = new DateInterval(
new LocalDate(2017, 6, 1),
new LocalDate(2017, 11, 30));
DateInterval juneToAugust = new DateInterval(
new LocalDate(2017, 6, 1),
new LocalDate(2017, 8, 31));
var result = januaryToAugust.Intersection(juneToNovember);
Console.WriteLine(result);
Output:
[2017-06-01, 2017-08-31]
Exceptions
Type | Condition |
---|---|
ArgumentException | interval uses a different
calendar to this date interval. |
ArgumentNullException | interval is null. |
ToString()
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String |
A string representation of this interval, as [start, end] ,
where "start" and "end" are the dates formatted using an ISO-8601 compatible pattern.
|
Overrides
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
Union(DateInterval)
Declaration
public DateInterval Union(DateInterval interval)
Parameters
Type | Name | Description |
---|---|---|
DateInterval | interval | The specified interval from which to generate the union interval. |
Returns
Type | Description |
---|---|
DateInterval | A DateInterval corresponding to the union between the given interval and the current instance, in the case the intervals overlap or are contiguous; a null reference otherwise. |
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.
Exceptions
Type | Condition |
---|---|
ArgumentException | interval uses a different calendar to this date interval. |
ArgumentNullException | interval is null. |
Operators
Equality(DateInterval, DateInterval)
Declaration
public static bool operator ==(DateInterval lhs, DateInterval rhs)
Parameters
Type | Name | Description |
---|---|---|
DateInterval | lhs | The first value to compare |
DateInterval | rhs | The second value to compare |
Returns
Type | Description |
---|---|
Boolean | True if the two date intervals have the same properties; false otherwise. |
Remarks
Inequality(DateInterval, DateInterval)
Declaration
public static bool operator !=(DateInterval lhs, DateInterval rhs)
Parameters
Type | Name | Description |
---|---|---|
DateInterval | lhs | The first value to compare |
DateInterval | rhs | The second value to compare |
Returns
Type | Description |
---|---|
Boolean | False if the two date intervals have the same start and end date; true otherwise. |
Remarks
Explicit Interface Implementations
IEnumerable.GetEnumerator()
Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type | Description |
---|---|
IEnumerator |
Remarks
The two dates must be in the same calendar, and the end date must not be earlier than the start date.
The end date is deemed to be part of the range, as this matches many real life uses of date ranges. For example, if someone says "I'm going to be on holiday from Monday to Friday," they usually mean that Friday is part of their holiday.