| java.lang.Object
 org.joda.time.base.BaseSingleFieldPeriod
org.joda.time.Minutes
| Minutes | | final public class Minutes extends BaseSingleFieldPeriod (Code) | | 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.
author:
Stephen Colebourne
since:
1.4 |
| Field Summary | |
| final public static Minutes | MAX_VALUE
Constant representing the maximum number of minutes that can be stored in this object. | | final public static Minutes | MIN_VALUE
Constant representing the minimum number of minutes that can be stored in this object. | | final public static Minutes | ONE
Constant representing one minute. | | final public static Minutes | THREE
Constant representing three minutes. | | final public static Minutes | TWO
Constant representing two minutes. | | final public static Minutes | ZERO
Constant representing zero minutes. |
| Method Summary | |
| public Minutes | dividedBy(int divisor)
Returns a new instance with the minutes divided by the specified divisor. | | public DurationFieldType | getFieldType()
Gets the duration field type, which is minutes. | | public int | getMinutes()
Gets the number of minutes that this period represents. | | public PeriodType | getPeriodType()
Gets the period type, which is minutes. | | public boolean | isGreaterThan(Minutes other)
Is this minutes instance greater than the specified number of minutes. | | public boolean | isLessThan(Minutes other)
Is this minutes instance less than the specified number of minutes. | | public Minutes | minus(int minutes)
Returns a new instance with the specified number of minutes taken away. | | public Minutes | minus(Minutes minutes)
Returns a new instance with the specified number of minutes taken away. | | public static Minutes | minutes(int minutes)
Obtains an instance of Minutes that may be cached. | | public static Minutes | minutesBetween(ReadableInstant start, ReadableInstant end)
Creates a Minutes representing the number of whole minutes
between the two specified datetimes. | | public static Minutes | minutesBetween(ReadablePartial start, ReadablePartial end)
Creates a Minutes representing the number of whole minutes
between the two specified partial datetimes. | | public static Minutes | minutesIn(ReadableInterval interval)
Creates a Minutes representing the number of whole minutes
in the specified interval. | | public Minutes | multipliedBy(int scalar)
Returns a new instance with the minutes multiplied by the specified scalar. | | public Minutes | negated()
Returns a new instance with the minutes value negated. | | public static Minutes | parseMinutes(String periodStr)
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. | | public Minutes | plus(int minutes)
Returns a new instance with the specified number of minutes added. | | public Minutes | plus(Minutes minutes)
Returns a new instance with the specified number of minutes added. | | public static Minutes | standardMinutesIn(ReadablePeriod period)
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. | | public Days | toStandardDays()
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. | | public Duration | toStandardDuration()
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. | | public Hours | toStandardHours()
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. | | public Seconds | toStandardSeconds()
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. | | public Weeks | toStandardWeeks()
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. | | public String | toString()
Gets this instance as a String in the ISO8601 duration format. |
| MAX_VALUE | | final public static Minutes MAX_VALUE(Code) | | Constant representing the maximum number of minutes that can be stored in this object.
|
| MIN_VALUE | | final public static Minutes MIN_VALUE(Code) | | Constant representing the minimum number of minutes that can be stored in this object.
|
| ONE | | final public static Minutes ONE(Code) | | Constant representing one minute.
|
| THREE | | final public static Minutes THREE(Code) | | Constant representing three minutes.
|
| TWO | | final public static Minutes TWO(Code) | | Constant representing two minutes.
|
| ZERO | | final public static Minutes ZERO(Code) | | Constant representing zero minutes.
|
| dividedBy | | public Minutes dividedBy(int divisor)(Code) | | 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.
Parameters:
divisor - the amount to divide by, may be negative the new period divided by the specified divisor
throws:
ArithmeticException - if the divisor is zero |
| getFieldType | | public DurationFieldType getFieldType()(Code) | | Gets the duration field type, which is minutes.
the period type |
| getMinutes | | public int getMinutes()(Code) | | Gets the number of minutes that this period represents.
the number of minutes in the period |
| getPeriodType | | public PeriodType getPeriodType()(Code) | | Gets the period type, which is minutes.
the period type |
| isGreaterThan | | public boolean isGreaterThan(Minutes other)(Code) | | Is this minutes instance greater than the specified number of minutes.
Parameters:
other - the other period, null means zero true if this minutes instance is greater than the specified one |
| isLessThan | | public boolean isLessThan(Minutes other)(Code) | | Is this minutes instance less than the specified number of minutes.
Parameters:
other - the other period, null means zero true if this minutes instance is less than the specified one |
| minus | | public Minutes minus(int minutes)(Code) | | Returns a new instance with the specified number of minutes taken away.
This instance is immutable and unaffected by this method call.
Parameters:
minutes - the amount of minutes to take away, may be negative the new period minus the specified number of minutes
throws:
ArithmeticException - if the result overflows an int |
| minus | | public Minutes minus(Minutes minutes)(Code) | | Returns a new instance with the specified number of minutes taken away.
This instance is immutable and unaffected by this method call.
Parameters:
minutes - the amount of minutes to take away, may be negative, null means zero the new period minus the specified number of minutes
throws:
ArithmeticException - if the result overflows an int |
| minutes | | public static Minutes minutes(int minutes)(Code) | | 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.
Parameters:
minutes - the number of minutes to obtain an instance for the instance of Minutes |
| minutesBetween | | public static Minutes minutesBetween(ReadableInstant start, ReadableInstant end)(Code) | | Creates a Minutes representing the number of whole minutes
between the two specified datetimes.
Parameters:
start - the start instant, must not be null
Parameters:
end - the end instant, must not be null the period in minutes
throws:
IllegalArgumentException - if the instants are null or invalid |
| minutesBetween | | public static Minutes minutesBetween(ReadablePartial start, ReadablePartial end)(Code) | | 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.
Parameters:
start - the start partial date, must not be null
Parameters:
end - the end partial date, must not be null the period in minutes
throws:
IllegalArgumentException - if the partials are null or invalid |
| minutesIn | | public static Minutes minutesIn(ReadableInterval interval)(Code) | | Creates a Minutes representing the number of whole minutes
in the specified interval.
Parameters:
interval - the interval to extract minutes from, null returns zero the period in minutes
throws:
IllegalArgumentException - if the partials are null or invalid |
| multipliedBy | | public Minutes multipliedBy(int scalar)(Code) | | Returns a new instance with the minutes multiplied by the specified scalar.
This instance is immutable and unaffected by this method call.
Parameters:
scalar - the amount to multiply by, may be negative the new period multiplied by the specified scalar
throws:
ArithmeticException - if the result overflows an int |
| negated | | public Minutes negated()(Code) | | Returns a new instance with the minutes value negated.
the new period with a negated value
throws:
ArithmeticException - if the result overflows an int |
| parseMinutes | | public static Minutes parseMinutes(String periodStr)(Code) | | 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.
Parameters:
periodStr - the period string, null returns zero the period in minutes
throws:
IllegalArgumentException - if the string format is invalid |
| plus | | public Minutes plus(int minutes)(Code) | | Returns a new instance with the specified number of minutes added.
This instance is immutable and unaffected by this method call.
Parameters:
minutes - the amount of minutes to add, may be negative the new period plus the specified number of minutes
throws:
ArithmeticException - if the result overflows an int |
| plus | | public Minutes plus(Minutes minutes)(Code) | | Returns a new instance with the specified number of minutes added.
This instance is immutable and unaffected by this method call.
Parameters:
minutes - the amount of minutes to add, may be negative, null means zero the new period plus the specified number of minutes
throws:
ArithmeticException - if the result overflows an int |
| standardMinutesIn | | public static Minutes standardMinutesIn(ReadablePeriod period)(Code) | | 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.
- One week consists of 7 days.
- One day consists of 24 hours.
- One hour consists of 60 minutes.
- One minute consists of 60 seconds.
- One second consists of 1000 milliseconds.
Months and Years are imprecise and periods containing these values cannot be converted.
Parameters:
period - the period to get the number of minutes from, null returns zero the period in minutes
throws:
IllegalArgumentException - if the period contains imprecise duration values |
| toStandardDays | | public Days toStandardDays()(Code) | | 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.
a period representing the number of whole days for this number of minutes |
| toStandardDuration | | public Duration toStandardDuration()(Code) | | 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.
a duration equivalent to this number of minutes |
| toStandardHours | | public Hours toStandardHours()(Code) | | 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.
a period representing the number of hours for this number of minutes |
| toStandardSeconds | | public Seconds toStandardSeconds()(Code) | | 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.
a period representing the number of seconds for this number of minutes
throws:
ArithmeticException - if the number of seconds is too large to be represented |
| toStandardWeeks | | public Weeks toStandardWeeks()(Code) | | 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.
a period representing the number of whole weeks for this number of minutes |
| toString | | public String toString()(Code) | | Gets this instance as a String in the ISO8601 duration format.
For example, "PT4M" represents 4 minutes.
the value as an ISO8601 string |
|
|