Class Instant

moduleceylon.time1.1.0

Search

Filter

A specific instant of time on a continuous time-scale.

An instant represents a single point in time irrespective of any time-zone offsets or geographical locations.

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

Instant
- Basic
  - Identifiable
  - Object
    Anything
- Comparable
- Enumerable
  - Ordinal
- ReadableInstant

no subtypes hierarchy

Initializer
`Instant(Integer millisecondsOfEpoch)` Parameters: `millisecondsOfEpoch` Internal value of an instant as a number of milliseconds since 1970-01-01T00:00:00.000Z.

Attributes
`hash`	Source Code`shared actual Integer hash` This implementation respect the constraint that if `x==y` then `x.hash==y.hash`. Refines `Identifiable.hash` ultimately refines `Object.hash`
`millisecondsOfEpoch`	Source Code`shared actual Integer millisecondsOfEpoch` Internal value of an instant as a number of milliseconds since 1970-01-01T00:00:00.000Z. Refines `ReadableInstant.millisecondsOfEpoch`
`string`	Source Code`shared actual String string` Returns ISO-8601 formatted String representation of this time of day in UTC. Reference: ISO-8601 Time Offsets from UTC Refines `Object.string`

Inherited Attributes
Attributes inherited from: `Ordinal<Other>` `Ordinal.predecessor`, `Ordinal.successor`
Attributes inherited from: `ReadableInstant` `ReadableInstant.millisecondsOfEpoch`

Methods
`compare`	Source Code `shared actual Comparison compare(Instant other)` Compares this instant to the other instant. Refines `Comparable.compare`
`date`	Source Code`shared Date date(TimeZone timeZone = ...)` Returns this instant as a `Date` value. Parameters: `timeZone = tz.system`
`dateTime`	Source Code`shared DateTime dateTime(TimeZone timeZone = ...)` Returns this instant as a `DateTime` value. Parameters: `timeZone = tz.system`
`durationFrom`	Source Code `shared Duration durationFrom(Instant other)` Returns duration in milliseconds from other instant to this instant.
`durationTo`	Source Code `shared Duration durationTo(Instant other)` Returns duration in milliseconds from this instant to the other instant.
`equals`	Source Code `shared actual Boolean equals(Object other)` Returns true if given value is same type and milliseconds of epoch. Refines `Identifiable.equals` ultimately refines `Object.equals`
`minus`	Source Code `shared Instant minus(Duration\|Period other)` Subtracts a period to this instant.
`neighbour`	Source Code `shared actual Instant neighbour(Integer offset)` The indirect successor or predecessor at the given `offset`, where: `x.neighbour(0) == x`, `x.neighbour(i+1) == x.neighbour(i).successor`, and `x.neighbour(i-1) == x.neighbour(i).predecessor`. Refines `Enumerable.neighbour`
`offset`	Source Code `shared actual Integer offset(Instant other)` Compute the offset from the given value, where: `x.offset(x) == 0`, and `x.successor.offset(x) == 1` if `x!=x.successor`. Refines `Enumerable.offset`
`plus`	Source Code `shared Instant plus(Duration\|Period other)` Adds a period to this instant.
`time`	Source Code`shared Time time(TimeZone timeZone = ...)` Returns time of day for this instant. Parameters: `timeZone = tz.system`
`zoneDateTime`	Source Code`shared ZoneDateTime zoneDateTime(TimeZone timeZone = ...)` Returns ZoneDateTime value for this instant. Parameters: `timeZone = tz.system`

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