org.joda.time
Class Minutes
- Comparable, ReadablePeriod, Serializable
public final class 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.
static Minutes | MAX_VALUE - Constant representing the maximum number of minutes that can be stored in this object.
|
static Minutes | MIN_VALUE - Constant representing the minimum number of minutes that can be stored in this object.
|
static Minutes | ONE - Constant representing one minute.
|
static Minutes | THREE - Constant representing three minutes.
|
static Minutes | TWO - Constant representing two minutes.
|
static Minutes | ZERO - Constant representing zero minutes.
|
between , between , compareTo , equals , get , getFieldType , getFieldType , getPeriodType , getValue , getValue , hashCode , isSupported , setValue , size , standardPeriodIn , toMutablePeriod , toPeriod |
MAX_VALUE
public static final Minutes MAX_VALUE
Constant representing the maximum number of minutes that can be stored in this object.
MIN_VALUE
public static final Minutes MIN_VALUE
Constant representing the minimum number of minutes that can be stored in this object.
ONE
public static final Minutes ONE
Constant representing one minute.
THREE
public static final Minutes THREE
Constant representing three minutes.
TWO
public static final Minutes TWO
Constant representing two minutes.
ZERO
public static final Minutes ZERO
Constant representing zero minutes.
dividedBy
public Minutes dividedBy(int divisor)
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
- the new period divided by the specified divisor
getMinutes
public int getMinutes()
Gets the number of minutes that this period represents.
- the number of minutes in the period
isGreaterThan
public boolean isGreaterThan(Minutes other)
Is this minutes instance greater than the specified number of minutes.
other
- the other period, null means zero
- true if this minutes instance is greater than the specified one
isLessThan
public boolean isLessThan(Minutes other)
Is this minutes instance less than the specified number of minutes.
other
- the other period, null means zero
- true if this minutes instance is less than the specified one
minus
public Minutes minus(int minutes)
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
- the new period minus the specified number of minutes
minus
public Minutes minus(Minutes minutes)
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
- the new period minus the specified number of minutes
minutes
public static Minutes minutes(int minutes)
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
minutesBetween
public static Minutes minutesBetween(ReadableInstant start,
ReadableInstant end)
Creates a Minutes
representing the number of whole minutes
between the two specified datetimes.
start
- the start instant, must not be nullend
- the end instant, must not be null
minutesBetween
public static Minutes minutesBetween(ReadablePartial start,
ReadablePartial end)
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 nullend
- the end partial date, must not be null
minutesIn
public static Minutes minutesIn(ReadableInterval interval)
Creates a Minutes
representing the number of whole minutes
in the specified interval.
interval
- the interval to extract minutes from, null returns zero
multipliedBy
public Minutes multipliedBy(int scalar)
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
- the new period multiplied by the specified scalar
negated
public Minutes negated()
Returns a new instance with the minutes value negated.
- the new period with a negated value
parseMinutes
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. If any other component is non-zero, an exception
will be thrown.
periodStr
- the period string, null returns zero
plus
public Minutes plus(int minutes)
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
- the new period plus the specified number of minutes
plus
public Minutes plus(Minutes minutes)
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
- the new period plus the specified number of minutes
standardMinutesIn
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. 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.
period
- the period to get the number of minutes from, null returns zero
toStandardDays
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. 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()
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()
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()
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
toStandardWeeks
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. 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()
Gets this instance as a String in the ISO8601 duration format.
For example, "PT4M" represents 4 minutes.
- toString in interface ReadablePeriod
- the value as an ISO8601 string
Copyright (c) 2001-2006 - Joda.org