Hours (ThreeTen date and time API)

java.lang.Object
- javax.time.period.field.PeriodField
- - javax.time.period.field.Hours

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Hours>
```
public final class Hours
extends PeriodField
implements java.lang.Comparable<Hours>, java.io.Serializable
```
A period representing a number of hours.
Hours is an immutable period that can only store hours. It is a type-safe way of representing a number of hours in an application.
Static factory methods allow you to construct instances. The number of hours may be queried using getHours(). Basic mathematical operations are provided - plus(), minus(), multipliedBy(), dividedBy() and negated(), all of which return a new instance
Hours is immutable and thread-safe.

Author:

Stephen Colebourne

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Hours ZERO
A constant for zero hours.

Fields
Modifier and Type	Field and Description
`static Hours`	`ZERO` A constant for zero hours.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(Hours otherHours)` Compares the number of hours in this instance to another instance.
`Hours`	`dividedBy(int divisor)` Returns a new instance with the hours divided by the specified divisor.
`int`	`getAmount()` Gets the number of hours held in this period.
`PeriodUnit`	`getUnit()` Gets the unit defining the amount of time.
`boolean`	`isGreaterThan(Hours otherHours)` Is the number of hours in this instance greater than that in another instance.
`boolean`	`isLessThan(Hours otherHours)` Is the number of hours in this instance less than that in another instance.
`Hours`	`minus(Hours hours)` Returns a new instance with the specified number of hours taken away.
`Hours`	`minus(int hours)` Returns a new instance with the specified number of hours taken away.
`Hours`	`multipliedBy(int scalar)` Returns a new instance with the hours multiplied by the specified scalar.
`Hours`	`negated()` Returns a new instance with the hours value negated.
`static Hours`	`of(int hours)` Obtains an instance of `Hours`.
`Hours`	`plus(Hours hours)` Returns a new instance with the specified number of hours added.
`Hours`	`plus(int hours)` Returns a new instance with the specified number of hours added.
`java.lang.String`	`toString()` Returns a string representation of the number of hours.
`Hours`	`withAmount(int amount)` Returns a new instance of the subclass with a different number of hours.

Methods inherited from class javax.time.period.field.PeriodField
equals, hashCode, toPeriodFields

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ZERO
```
public static final Hours ZERO
```
    A constant for zero hours.
- Method Detail
  - of
```
public static Hours of(int hours)
```
    Obtains an instance of Hours.
    
    Parameters:
    hours - the number of hours the instance will represent
    
    Returns:
    the created Hours
  - getAmount
```
public int getAmount()
```
    Gets the number of hours held in this period.
    
    Specified by:
    
    getAmount in class PeriodField
    
    Returns:
    the number of hours
  - withAmount
```
public Hours withAmount(int amount)
```
    Returns a new instance of the subclass with a different number of hours.
    
    Specified by:
    
    withAmount in class PeriodField
    
    Parameters:
    amount - the number of hours to set in the new instance, may be negative
    
    Returns:
    a new period element, never null
  - getUnit
```
public PeriodUnit getUnit()
```
    Gets the unit defining the amount of time.
    
    Specified by:
    
    getUnit in class PeriodField
    
    Returns:
    the hours unit, never null
  - plus
```
public Hours plus(int hours)
```
    Returns a new instance with the specified number of hours added.
    This instance is immutable and unaffected by this method call.
    
    Overrides:
    
    plus in class PeriodField
    
    Parameters:
    hours - the amount of hours to add, may be negative
    
    Returns:
    the new period plus the specified number of hours
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows an int
  - plus
```
public Hours plus(Hours hours)
```
    Returns a new instance with the specified number of hours added.
    This instance is immutable and unaffected by this method call.
    
    Parameters:
    hours - the amount of hours to add, may be negative, not null
    
    Returns:
    the new period plus the specified number of hours
    
    Throws:
    
    java.lang.NullPointerException - if the hours to add is null
    
    java.lang.ArithmeticException - if the result overflows an int
  - minus
```
public Hours minus(int hours)
```
    Returns a new instance with the specified number of hours taken away.
    This instance is immutable and unaffected by this method call.
    
    Overrides:
    
    minus in class PeriodField
    
    Parameters:
    hours - the amount of hours to take away, may be negative
    
    Returns:
    the new period minus the specified number of hours
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows an int
  - minus
```
public Hours minus(Hours hours)
```
    Returns a new instance with the specified number of hours taken away.
    This instance is immutable and unaffected by this method call.
    
    Parameters:
    hours - the amount of hours to take away, may be negative, not null
    
    Returns:
    the new period minus the specified number of hours
    
    Throws:
    
    java.lang.NullPointerException - if the hours to add is null
    
    java.lang.ArithmeticException - if the result overflows an int
  - multipliedBy
```
public Hours multipliedBy(int scalar)
```
    Returns a new instance with the hours multiplied by the specified scalar.
    This instance is immutable and unaffected by this method call.
    
    Overrides:
    
    multipliedBy in class PeriodField
    
    Parameters:
    scalar - the amount to multiply by, may be negative
    
    Returns:
    the new period multiplied by the specified scalar
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows an int
  - dividedBy
```
public Hours dividedBy(int divisor)
```
    Returns a new instance with the hours divided by the specified divisor. The calculation uses integer division, thus 3 divided by 2 is 1.
    This instance is immutable and unaffected by this method call.
    
    Overrides:
    
    dividedBy in class PeriodField
    
    Parameters:
    divisor - the amount to divide by, may be negative
    
    Returns:
    the new period divided by the specified divisor
    
    Throws:
    
    java.lang.ArithmeticException - if the divisor is zero
  - negated
```
public Hours negated()
```
    Returns a new instance with the hours value negated.
    
    Overrides:
    
    negated in class PeriodField
    
    Returns:
    the new period with a negated value
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows an int
  - compareTo
```
public int compareTo(Hours otherHours)
```
    Compares the number of hours in this instance to another instance.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Hours>
    
    Parameters:
    otherHours - the other number of hours, not null
    
    Returns:
    the comparator value, negative if less, postive if greater
    
    Throws:
    
    java.lang.NullPointerException - if otherHours is null
  - isGreaterThan
```
public boolean isGreaterThan(Hours otherHours)
```
    Is the number of hours in this instance greater than that in another instance.
    
    Parameters:
    otherHours - the other number of hours, not null
    
    Returns:
    true if this number of hours is greater
    
    Throws:
    
    java.lang.NullPointerException - if otherHours is null
  - isLessThan
```
public boolean isLessThan(Hours otherHours)
```
    Is the number of hours in this instance less than that in another instance.
    
    Parameters:
    otherHours - the other number of hours, not null
    
    Returns:
    true if this number of hours is less
    
    Throws:
    
    java.lang.NullPointerException - if otherHours is null
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the number of hours. This will be in the format 'PTnH' where n is the number of hours.
    
    Specified by:
    
    toString in class PeriodField
    
    Returns:
    the number of hours in ISO8601 string format

Class Hours

Field Summary

Method Summary

Methods inherited from class javax.time.period.field.PeriodField

Methods inherited from class java.lang.Object

Field Detail

ZERO

Method Detail

of

getAmount

withAmount

getUnit

plus

plus

minus

minus

multipliedBy

dividedBy

negated

compareTo

isGreaterThan

isLessThan

toString