Class Minutes
 java.lang.Object

 org.joda.time.base.BaseSingleFieldPeriod

 org.joda.time.Minutes

 All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<BaseSingleFieldPeriod>
,ReadablePeriod
public final class Minutes extends BaseSingleFieldPeriod
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 typesafe 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()
anddividedBy()
.Minutes
is threadsafe and immutable. Since:
 1.4
 See Also:
 Serialized Form


Field Summary
Fields Modifier and Type Field Description 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.

Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Minutes
dividedBy(int divisor)
Returns a new instance with the minutes divided by the specified divisor.DurationFieldType
getFieldType()
Gets the duration field type, which isminutes
.int
getMinutes()
Gets the number of minutes that this period represents.PeriodType
getPeriodType()
Gets the period type, which isminutes
.boolean
isGreaterThan(Minutes other)
Is this minutes instance greater than the specified number of minutes.boolean
isLessThan(Minutes other)
Is this minutes instance less than the specified number of minutes.Minutes
minus(int minutes)
Returns a new instance with the specified number of minutes taken away.Minutes
minus(Minutes minutes)
Returns a new instance with the specified number of minutes taken away.static Minutes
minutes(int minutes)
Obtains an instance ofMinutes
that may be cached.static Minutes
minutesBetween(ReadableInstant start, ReadableInstant end)
Creates aMinutes
representing the number of whole minutes between the two specified datetimes.static Minutes
minutesBetween(ReadablePartial start, ReadablePartial end)
Creates aMinutes
representing the number of whole minutes between the two specified partial datetimes.static Minutes
minutesIn(ReadableInterval interval)
Creates aMinutes
representing the number of whole minutes in the specified interval.Minutes
multipliedBy(int scalar)
Returns a new instance with the minutes multiplied by the specified scalar.Minutes
negated()
Returns a new instance with the minutes value negated.static Minutes
parseMinutes(java.lang.String periodStr)
Creates a newMinutes
by parsing a string in the ISO8601 format 'PTnM'.Minutes
plus(int minutes)
Returns a new instance with the specified number of minutes added.Minutes
plus(Minutes minutes)
Returns a new instance with the specified number of minutes added.static Minutes
standardMinutesIn(ReadablePeriod period)
Creates a newMinutes
representing the number of complete standard length minutes in the specified period.Days
toStandardDays()
Converts this period in minutes to a period in days assuming a 24 hour day and 60 minute hour.Duration
toStandardDuration()
Converts this period in minutes to a duration in milliseconds assuming a 60 second minute.Hours
toStandardHours()
Converts this period in minutes to a period in hours assuming a 60 minute hour.Seconds
toStandardSeconds()
Converts this period in minutes to a period in seconds assuming a 60 second minute.Weeks
toStandardWeeks()
Converts this period in minutes to a period in weeks assuming a 7 days week, 24 hour day and 60 minute hour.java.lang.String
toString()
Gets this instance as a String in the ISO8601 duration format.
Methods inherited from class org.joda.time.base.BaseSingleFieldPeriod
compareTo, equals, get, getFieldType, getValue, hashCode, isSupported, size, toMutablePeriod, toPeriod




Field Detail

ZERO
public static final Minutes ZERO
Constant representing zero minutes.

ONE
public static final Minutes ONE
Constant representing one minute.

TWO
public static final Minutes TWO
Constant representing two minutes.

THREE
public static final Minutes THREE
Constant representing three minutes.

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.


Method Detail

minutes
public static Minutes minutes(int minutes)
Obtains an instance ofMinutes
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 Returns:
 the instance of Minutes

minutesBetween
public static Minutes minutesBetween(ReadableInstant start, ReadableInstant end)
Creates aMinutes
representing the number of whole minutes between the two specified datetimes. Parameters:
start
 the start instant, must not be nullend
 the end instant, must not be null Returns:
 the period in minutes
 Throws:
java.lang.IllegalArgumentException
 if the instants are null or invalid

minutesBetween
public static Minutes minutesBetween(ReadablePartial start, ReadablePartial end)
Creates aMinutes
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 nullend
 the end partial date, must not be null Returns:
 the period in minutes
 Throws:
java.lang.IllegalArgumentException
 if the partials are null or invalid

minutesIn
public static Minutes minutesIn(ReadableInterval interval)
Creates aMinutes
representing the number of whole minutes in the specified interval. Parameters:
interval
 the interval to extract minutes from, null returns zero Returns:
 the period in minutes
 Throws:
java.lang.IllegalArgumentException
 if the partials are null or invalid

standardMinutesIn
public static Minutes standardMinutesIn(ReadablePeriod period)
Creates a newMinutes
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.
 Parameters:
period
 the period to get the number of minutes from, null returns zero Returns:
 the period in minutes
 Throws:
java.lang.IllegalArgumentException
 if the period contains imprecise duration values

parseMinutes
public static Minutes parseMinutes(java.lang.String periodStr)
Creates a newMinutes
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 nonzero. If any other component is nonzero, an exception will be thrown.
 Parameters:
periodStr
 the period string, null returns zero Returns:
 the period in minutes
 Throws:
java.lang.IllegalArgumentException
 if the string format is invalid

getFieldType
public DurationFieldType getFieldType()
Gets the duration field type, which isminutes
. Specified by:
getFieldType
in classBaseSingleFieldPeriod
 Returns:
 the period type

getPeriodType
public PeriodType getPeriodType()
Gets the period type, which isminutes
. Specified by:
getPeriodType
in interfaceReadablePeriod
 Specified by:
getPeriodType
in classBaseSingleFieldPeriod
 Returns:
 the period type

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.
 Returns:
 a period representing the number of whole weeks for this number of minutes

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.
 Returns:
 a period representing the number of whole days for 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.
 Returns:
 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.
 Returns:
 a period representing the number of seconds for this number of minutes
 Throws:
java.lang.ArithmeticException
 if the number of seconds is too large to be represented

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.
 Returns:
 a duration equivalent to this number of minutes

getMinutes
public int getMinutes()
Gets the number of minutes that this period represents. Returns:
 the number of minutes in the period

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.
 Parameters:
minutes
 the amount of minutes to add, may be negative Returns:
 the new period plus the specified number of minutes
 Throws:
java.lang.ArithmeticException
 if the result overflows an int

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.
 Parameters:
minutes
 the amount of minutes to add, may be negative, null means zero Returns:
 the new period plus the specified number of minutes
 Throws:
java.lang.ArithmeticException
 if the result overflows an int

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.
 Parameters:
minutes
 the amount of minutes to take away, may be negative Returns:
 the new period minus the specified number of minutes
 Throws:
java.lang.ArithmeticException
 if the result overflows an int

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.
 Parameters:
minutes
 the amount of minutes to take away, may be negative, null means zero Returns:
 the new period minus the specified number of minutes
 Throws:
java.lang.ArithmeticException
 if the result overflows an int

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.
 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 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.
 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 Minutes negated()
Returns a new instance with the minutes value negated. Returns:
 the new period with a negated value
 Throws:
java.lang.ArithmeticException
 if the result overflows an int

isGreaterThan
public boolean isGreaterThan(Minutes other)
Is this minutes instance greater than the specified number of minutes. Parameters:
other
 the other period, null means zero Returns:
 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. Parameters:
other
 the other period, null means zero Returns:
 true if this minutes instance is less than the specified one

toString
public java.lang.String toString()
Gets this instance as a String in the ISO8601 duration format.For example, "PT4M" represents 4 minutes.
 Specified by:
toString
in interfaceReadablePeriod
 Overrides:
toString
in classjava.lang.Object
 Returns:
 the value as an ISO8601 string

