Class Month

moduleceylon.time1.3.1

Index
Search
Filter

A month in a Gregorian or Julian calendar system.

Anything
- Object
  - Basic ...and other supertypes
    Month ...and other supertypes

Month
- Basic
  - Identifiable
  - Object
    Anything
- Comparable
- Enumerable
  - Ordinal
- Ordinal

Month of
- april
- august
- december
- february
- january
- july
- june
- march
- may
- november
- october
- september

Initializer
`Month(Integer integer)` Parameters: `integer` Ordinal number of the month of year. Where: january = 1 february = 2 … december = 12

Attributes
`integer`	Source Code`shared Integer integer` Ordinal number of the month of year. Where: january = 1 february = 2 … december = 12

Inherited Attributes
Attributes inherited from: `Object` `hash`, `string`
Attributes inherited from: `Enumerable<Other>` `predecessor`, `successor`
Attributes inherited from: `Ordinal<Other>` `predecessor`, `successor`

Methods
`add`	Source Code `shared Overflow add(Integer numberOfMonths)` Adds number of months to this month and returns the result as new month value and number of times the operation overflowed.
`compare`	Source Code `shared actual Comparison compare(Month other)` Compares ordinal numbers of two instances of `Month`. Refines `Comparable.compare`
`firstDayOfYear`	Source Code`shared default Integer firstDayOfYear(Boolean leapYear = false)` Returns the day of year value for first of this month. Parameters: `leapYear = false`
`minusMonths`	Source Code `shared Month minusMonths(Integer number)` Returns month of year that comes specified number of months before this month.
`neighbour`	Source Code `shared actual Month neighbour(Integer offset)` returns `n`-th neighbour of this day of week. For example: assert(january.neighbour(0) == january); assert(january.neighbour(1) == february); assert(january.neighbour(-1) == december); Refines `Enumerable.neighbour`
`numberOfDays`	Source Code`shared default Integer numberOfDays(Boolean leapYear = false)` Returns number of days in this month. Parameters: `leapYear = false`
`offset`	Source Code `shared actual default Integer offset(Month other)` Returns the offset of the other month compared to this. This will always return positive integer such that given any two months `a` and `b`, the following is always true: assert(0 <= a.offset(b) <= 11); Refines `Enumerable.offset`
`plusMonths`	Source Code `shared Month plusMonths(Integer number)` Returns month of year that comes specified number of months after this month.

Inherited Methods
Methods inherited from: `Object` `equals()`
Methods inherited from: `Comparable<Other>` `compare()`, `largerThan()`, `notLargerThan()`, `notSmallerThan()`, `smallerThan()`
Methods inherited from: `Enumerable<Other>` `neighbour()`, `offset()`, `offsetSign()`

Nested Classes
`Overflow`	Source Code`shared Overflow` A result of adding or subtracting a month to another amount.