# Time¶

common

`class Time(hour: Int, minute: Int, second: Int, nanosecond: Int) : Comparable<Time> `

A time of day in an ambiguous region.

## Parameters¶

common

hour | the hour of day |

minute | the minute of the hour |

second | the second of the minute |

nanosecond | the nanosecond of the second |

## Throws¶

io.islandtime.DateTimeException | if the time is invalid |

## Constructors¶

Time | common `fun Time(hour: Int, minute: Int, second: Int = 0, nanosecond: Int = 0)` Creates a Time from its individual components. |

## Types¶

Name | Summary |
---|---|

Companion | common `object Companion` |

## Functions¶

Name | Summary |
---|---|

compareTo | common `open operator override fun compareTo(other: Time): Int` |

component1 | common `operator fun component1(): Int` |

component2 | common `operator fun component2(): Int` |

component3 | common `operator fun component3(): Int` |

component4 | common `operator fun component4(): Int` |

copy | common `fun copy(hour: Int = this.hour, minute: Int = this.minute, second: Int = this.second, nanosecond: Int = this.nanosecond): Time` Returns a copy of this time with the values of any individual components replaced by the new values specified. |

equals | common `open operator override fun equals(other: Any?): Boolean` |

hashCode | common `open override fun hashCode(): Int` |

minus | common `operator fun minus(duration: Duration): Time` common `operator fun minus(hours: Hours): Time` Returns this time with hours subtracted from it. common `operator fun minus(microseconds: Microseconds): Time` Returns this time with microseconds subtracted from it. common `operator fun minus(milliseconds: Milliseconds): Time` Returns this time with milliseconds subtracted from it. common `operator fun minus(minutes: Minutes): Time` Returns this time with minutes subtracted from it. common `operator fun minus(nanoseconds: Nanoseconds): Time` Returns this time with nanoseconds subtracted from it. common `operator fun minus(seconds: Seconds): Time` Returns this time with seconds subtracted from it. common `operator fun minus(duration: Duration): Time` Returns this time with duration subtracted from it. |

plus | common `operator fun plus(duration: Duration): Time` common `operator fun plus(hours: Hours): Time` Returns this time with hours added to it. common `operator fun plus(microseconds: Microseconds): Time` Returns this time with microseconds added to it. common `operator fun plus(milliseconds: Milliseconds): Time` Returns this time with milliseconds added to it. common `operator fun plus(minutes: Minutes): Time` Returns this time with minutes added to it. common `operator fun plus(nanoseconds: Nanoseconds): Time` Returns this time with nanoseconds added to it. common `operator fun plus(seconds: Seconds): Time` Returns this time with seconds added to it. common `operator fun plus(duration: Duration): Time` Returns this time with duration added to it. |

toString | common `open override fun toString(): String` Converts this time to a string in ISO-8601 extended format. For example, `17:31:45.923452091` or `02:30` . |

## Properties¶

Name | Summary |
---|---|

hour | common `val hour: Int` The hour of the day. |

minute | common `val minute: Int` The minute of the hour. |

nanosecond | common `val nanosecond: Int = 0` The nanosecond of the second. |

nanosecondOfDay | common `val nanosecondOfDay: Long` The nanosecond of the day. |

nanosecondsSinceStartOfDay | common `val nanosecondsSinceStartOfDay: Nanoseconds` The number of nanoseconds since the start of the day. |

second | common `val second: Int = 0` The second of the minute. |

secondOfDay | common `val secondOfDay: Int` The second of the day. |

secondsSinceStartOfDay | common `val secondsSinceStartOfDay: Seconds` The number of seconds since the start of the day. |

## Extensions¶

Name | Summary |
---|---|

at | common `infix fun Time.at(offset: UtcOffset): OffsetTime` Combines a local time with a UTC offset to create an OffsetTime. |

roundedDownTo | common `fun Time.roundedDownTo(unit: TimeUnit): Time` Returns this time, rounded down to match the precision of a given unit. |

roundedDownToNearest | common `fun Time.roundedDownToNearest(increment: Hours): Time` Returns this time, rounded down to the nearest hour that satisfies the increment. common `fun Time.roundedDownToNearest(increment: Minutes): Time` Returns this time, rounded down to the nearest minute that satisfies the increment. common `fun Time.roundedDownToNearest(increment: Seconds): Time` Returns this time, rounded down to the nearest second that satisfies the increment. common `fun Time.roundedDownToNearest(increment: Milliseconds): Time` Returns this time, rounded down to the nearest millisecond that satisfies the increment. common `fun Time.roundedDownToNearest(increment: Microseconds): Time` Returns this time, rounded down to the nearest microsecond that satisfies the increment. common `fun Time.roundedDownToNearest(increment: Nanoseconds): Time` Returns this time, rounded down to the nearest nanosecond that satisfies the increment. |

roundedTo | common `fun Time.roundedTo(unit: TimeUnit): Time` Returns this time, rounded to match the precision of a given unit. If the time is halfway between whole values of the unit, it will be rounded up. |

roundedToNearest | common `fun Time.roundedToNearest(increment: Hours): Time` Returns this time, rounded to the nearest hour that satisfies the increment. If the time is halfway between increments, it will be rounded up. common `fun Time.roundedToNearest(increment: Minutes): Time` Returns this time, rounded to the nearest minute that satisfies the increment. If the time is halfway between increments, it will be rounded up. common `fun Time.roundedToNearest(increment: Seconds): Time` Returns this time, rounded to the nearest second that satisfies the increment. If the time is halfway between increments, it will be rounded up. common `fun Time.roundedToNearest(increment: Milliseconds): Time` Returns this time, rounded to the nearest millisecond that satisfies the increment. If the time is halfway between increments, it will be rounded up. common `fun Time.roundedToNearest(increment: Microseconds): Time` Returns this time, rounded to the nearest microsecond that satisfies the increment. If the time is halfway between increments, it will be rounded up. common `fun Time.roundedToNearest(increment: Nanoseconds): Time` Returns this time, rounded to the nearest nanosecond that satisfies the increment. If the time is halfway between increments, it will be rounded up. |

roundedUpTo | common `fun Time.roundedUpTo(unit: TimeUnit): Time` Returns this time, rounded up to match the precision of a given unit. |

roundedUpToNearest | common `fun Time.roundedUpToNearest(increment: Hours): Time` Returns this time, rounded up to the nearest hour that satisfies the increment. common `fun Time.roundedUpToNearest(increment: Minutes): Time` Returns this time, rounded up to the nearest minute that satisfies the increment. common `fun Time.roundedUpToNearest(increment: Seconds): Time` Returns this time, rounded up to the nearest second that satisfies the increment. common `fun Time.roundedUpToNearest(increment: Milliseconds): Time` Returns this time, rounded up to the nearest millisecond that satisfies the increment. common `fun Time.roundedUpToNearest(increment: Microseconds): Time` Returns this time, rounded up to the nearest microsecond that satisfies the increment. common `fun Time.roundedUpToNearest(increment: Nanoseconds): Time` Returns this time, rounded up to the nearest nanosecond that satisfies the increment. |

toJavaLocalTime | jvm `fun Time.toJavaLocalTime(): LocalTime` Converts this time to an equivalent Java `LocalTime` . |

toNSDateComponents | darwin `fun Time.toNSDateComponents(includeCalendar: Boolean = false): <ERROR CLASS>` Converts this time to an equivalent `NSDateComponents` object. |

truncatedTo | common `fun Time.truncatedTo(unit: TimeUnit): Time` Returns this time, rounded down to match the precision of a given unit. |