java.lang.Object | ||
↳ | org.joda.time.base.BaseSingleFieldPeriod | |
↳ | org.joda.time.Minutes |
An immutable time period representing a number of minutes.
Minutes
is an immutable period that can only store minutes.
It does not store years, months or hours for example. As such it is a
type-safe way of representing a number of minutes in an application.
The number of minutes is set in the constructor, and may be queried using
getMinutes()
. Basic mathematical operations are provided -
plus()
, minus()
, multipliedBy()
and
dividedBy()
.
Minutes
is thread-safe and immutable.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
MAX_VALUE | Constant representing the maximum number of minutes that can be stored in this object. | ||||||||||
MIN_VALUE | Constant representing the minimum number of minutes that can be stored in this object. | ||||||||||
ONE | Constant representing one minute. | ||||||||||
THREE | Constant representing three minutes. | ||||||||||
TWO | Constant representing two minutes. | ||||||||||
ZERO | Constant representing zero minutes. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns a new instance with the minutes divided by the specified divisor.
| |||||||||||
Gets the duration field type, which is
minutes . | |||||||||||
Gets the number of minutes that this period represents.
| |||||||||||
Gets the period type, which is
minutes . | |||||||||||
Is this minutes instance greater than the specified number of minutes.
| |||||||||||
Is this minutes instance less than the specified number of minutes.
| |||||||||||
Returns a new instance with the specified number of minutes taken away.
| |||||||||||
Returns a new instance with the specified number of minutes taken away.
| |||||||||||
Obtains an instance of
Minutes that may be cached. | |||||||||||
Creates a
Minutes representing the number of whole minutes
between the two specified datetimes. | |||||||||||
Creates a
Minutes representing the number of whole minutes
between the two specified partial datetimes. | |||||||||||
Creates a
Minutes representing the number of whole minutes
in the specified interval. | |||||||||||
Returns a new instance with the minutes multiplied by the specified scalar.
| |||||||||||
Returns a new instance with the minutes value negated.
| |||||||||||
Creates a new
Minutes by parsing a string in the ISO8601 format 'PTnM'. | |||||||||||
Returns a new instance with the specified number of minutes added.
| |||||||||||
Returns a new instance with the specified number of minutes added.
| |||||||||||
Creates a new
Minutes representing the number of complete
standard length minutes in the specified period. | |||||||||||
Converts this period in minutes to a period in days assuming a
24 hour day and 60 minute hour.
| |||||||||||
Converts this period in minutes to a duration in milliseconds assuming a
60 second minute.
| |||||||||||
Converts this period in minutes to a period in hours assuming a
60 minute hour.
| |||||||||||
Converts this period in minutes to a period in seconds assuming a
60 second minute.
| |||||||||||
Converts this period in minutes to a period in weeks assuming a
7 days week, 24 hour day and 60 minute hour.
| |||||||||||
Gets this instance as a String in the ISO8601 duration format.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.joda.time.base.BaseSingleFieldPeriod
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Comparable
| |||||||||||
From interface
org.joda.time.ReadablePeriod
|
Constant representing the maximum number of minutes that can be stored in this object.
Constant representing the minimum number of minutes that can be stored in this object.
Returns a new instance with the minutes 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.
divisor | the amount to divide by, may be negative |
---|
ArithmeticException | if the divisor is zero |
---|
Gets the duration field type, which is minutes
.
Gets the number of minutes that this period represents.
Is this minutes instance greater than the specified number of minutes.
other | the other period, null means zero |
---|
Is this minutes instance less than the specified number of minutes.
other | the other period, null means zero |
---|
Returns a new instance with the specified number of minutes taken away.
This instance is immutable and unaffected by this method call.
minutes | the amount of minutes to take away, may be negative |
---|
ArithmeticException | if the result overflows an int |
---|
Returns a new instance with the specified number of minutes taken away.
This instance is immutable and unaffected by this method call.
minutes | the amount of minutes to take away, may be negative, null means zero |
---|
ArithmeticException | if the result overflows an int |
---|
Obtains an instance of Minutes
that may be cached.
Minutes
is immutable, so instances can be cached and shared.
This factory method provides access to shared instances.
minutes | the number of minutes to obtain an instance for |
---|
Creates a Minutes
representing the number of whole minutes
between the two specified datetimes.
start | the start instant, must not be null |
---|---|
end | the end instant, must not be null |
IllegalArgumentException | if the instants are null or invalid |
---|
Creates a Minutes
representing the number of whole minutes
between the two specified partial datetimes.
The two partials must contain the same fields, for example you can specify
two LocalTime
objects.
start | the start partial date, must not be null |
---|---|
end | the end partial date, must not be null |
IllegalArgumentException | if the partials are null or invalid |
---|
Creates a Minutes
representing the number of whole minutes
in the specified interval.
interval | the interval to extract minutes from, null returns zero |
---|
IllegalArgumentException | if the partials are null or invalid |
---|
Returns a new instance with the minutes multiplied by the specified scalar.
This instance is immutable and unaffected by this method call.
scalar | the amount to multiply by, may be negative |
---|
ArithmeticException | if the result overflows an int |
---|
Returns a new instance with the minutes value negated.
ArithmeticException | if the result overflows an int |
---|
Creates a new Minutes
by parsing a string in the ISO8601 format 'PTnM'.
The parse will accept the full ISO syntax of PnYnMnWnDTnHnMnS however only the minutes component may be non-zero. If any other component is non-zero, an exception will be thrown.
periodStr | the period string, null returns zero |
---|
IllegalArgumentException | if the string format is invalid |
---|
Returns a new instance with the specified number of minutes added.
This instance is immutable and unaffected by this method call.
minutes | the amount of minutes to add, may be negative, null means zero |
---|
ArithmeticException | if the result overflows an int |
---|
Returns a new instance with the specified number of minutes added.
This instance is immutable and unaffected by this method call.
minutes | the amount of minutes to add, may be negative |
---|
ArithmeticException | if the result overflows an int |
---|
Creates a new Minutes
representing the number of complete
standard length minutes in the specified period.
This factory method converts all fields from the period to minutes using standardised durations for each field. Only those fields which have a precise duration in the ISO UTC chronology can be converted.
period | the period to get the number of minutes from, null returns zero |
---|
IllegalArgumentException | if the period contains imprecise duration values |
---|
Converts this period in minutes to a period in days assuming a 24 hour day and 60 minute hour.
This method allows you to convert between different types of period. However to achieve this it makes the assumption that all days are 24 hours long and all hours are 60 minutes long. This is not true when daylight savings is considered and may also not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.
Converts this period in minutes to a duration in milliseconds assuming a 60 second minute.
This method allows you to convert from a period to a duration. However to achieve this it makes the assumption that all minutes are 60 seconds long. This might not be true for an unusual chronology, for example one that takes leap seconds into account. However, the method is included as it is a useful operation for many applications and business rules.
Converts this period in minutes to a period in hours assuming a 60 minute hour.
This method allows you to convert between different types of period. However to achieve this it makes the assumption that all hours are 60 minutes long. This may not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.
Converts this period in minutes to a period in seconds assuming a 60 second minute.
This method allows you to convert between different types of period. However to achieve this it makes the assumption that all minutes are 60 seconds long. This may not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.
ArithmeticException | if the number of seconds is too large to be represented |
---|
Converts this period in minutes to a period in weeks assuming a 7 days week, 24 hour day and 60 minute hour.
This method allows you to convert between different types of period. However to achieve this it makes the assumption that all weeks are 7 days long, all days are 24 hours long and all hours are 60 minutes long. This is not true when daylight savings is considered and may also not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.
Gets this instance as a String in the ISO8601 duration format.
For example, "PT4M" represents 4 minutes.