Interface Date

moduleceylon.time1.3.1

Index
Search
Filter

An interface for date objects in the ISO-8601 calendar system.

A date is often viewed as triple of year-month-day values. This interface also defines access to other date fields such as day-of-year, day-of-week and week-of-year.

no type hierarchy

Date
- Comparable
- DateBehavior
  - MonthBehavior
  - YearBehavior
- Enumerable
  - Ordinal
- Ordinal
- ReadableDate
  - ReadableMonth
  - ReadableYear

Date
- GregorianDate

Attributes
`hash`	Source Code`shared actual default Integer hash` Implementation compatible with `equals()` method. This implementation respect the constraint that if `x==y` then `x.hash==y.hash`. Refines `Object.hash`

Inherited Attributes
Attributes inherited from: `Object` `hash`, `string`
Attributes inherited from: `Enumerable<Other>` `predecessor`, `successor`
Attributes inherited from: `Ordinal<Other>` `predecessor`, `successor`
Attributes inherited from: `ReadableDate` `day`, `dayOfEra`, `dayOfWeek`, `dayOfYear`, `weekOfYear`
Attributes inherited from: `ReadableMonth` `month`
Attributes inherited from: `ReadableYear` `leapYear`, `year`

Methods
`at`	Source Code `shared formal DateTime at(Time time)` Returns new DateTime value based on this date and a specified time.
`equals`	Source Code `shared actual default Boolean equals(Object other)` Checks if this date is equal to another date. Compares this Date with another ensuring that the date both objects refer to is the same. Refines `Object.equals`
`minus`	Source Code `shared formal Date minus(ReadableDatePeriod period)` Subtracts a specified period to this date.
`periodFrom`	Source Code `shared formal Period periodFrom(Date start)` Returns the period between this and the given date. If this date is before the given date then return zero period.
`periodTo`	Source Code `shared formal Period periodTo(Date end)` Returns the period between this and the given date. If this date is after the given date then return zero period.
`plus`	Source Code `shared formal Date plus(ReadableDatePeriod period)` Adds a specified period to this date.
`rangeTo`	Source Code `shared formal DateRange rangeTo(Date other)` Returns the `DateRange` between this and given `Date`.

Inherited Methods
Methods inherited from: `Object` `equals()`
Methods inherited from: `Comparable<Other>` `compare()`, `largerThan()`, `notLargerThan()`, `notSmallerThan()`, `smallerThan()`
Methods inherited from: `DateBehavior<Element>` `minusDays()`, `minusWeeks()`, `plusDays()`, `plusWeeks()`, `withDay()`, `withDayOfWeek()`, `withDayOfYear()`, `withWeekOfYear()`
Methods inherited from: `Enumerable<Other>` `neighbour()`, `offset()`, `offsetSign()`
Methods inherited from: `MonthBehavior<Element>` `minusMonths()`, `plusMonths()`, `withMonth()`
Methods inherited from: `YearBehavior<Element>` `minusYears()`, `plusYears()`, `withYear()`