public final class Minutes extends BaseSingleFieldPeriod
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()
and
dividedBy()
.
Minutes
is threadsafe and immutable.
Modifier and Type  Field and 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.

Modifier and Type  Method and 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 is
minutes . 
int 
getMinutes()
Gets the number of minutes that this period represents.

PeriodType 
getPeriodType()
Gets the period type, which is
minutes . 
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 of
Minutes that may be cached. 
static Minutes 
minutesBetween(ReadableInstant start,
ReadableInstant end)
Creates a
Minutes representing the number of whole minutes
between the two specified datetimes. 
static Minutes 
minutesBetween(ReadablePartial start,
ReadablePartial end)
Creates a
Minutes representing the number of whole minutes
between the two specified partial datetimes. 
static Minutes 
minutesIn(ReadableInterval interval)
Creates a
Minutes 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(String periodStr)
Creates a new
Minutes 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 new
Minutes 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.

String 
toString()
Gets this instance as a String in the ISO8601 duration format.

between, between, compareTo, equals, get, getFieldType, getValue, getValue, hashCode, isSupported, setValue, size, standardPeriodIn, toMutablePeriod, toPeriod
public static final Minutes ZERO
public static final Minutes ONE
public static final Minutes TWO
public static final Minutes THREE
public static final Minutes MAX_VALUE
public static final Minutes MIN_VALUE
public static Minutes minutes(int minutes)
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 forpublic static Minutes minutesBetween(ReadableInstant start, ReadableInstant end)
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 nullIllegalArgumentException
 if the instants are null or invalidpublic static Minutes minutesBetween(ReadablePartial start, ReadablePartial end)
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 nullIllegalArgumentException
 if the partials are null or invalidpublic static Minutes minutesIn(ReadableInterval interval)
Minutes
representing the number of whole minutes
in the specified interval.interval
 the interval to extract minutes from, null returns zeroIllegalArgumentException
 if the partials are null or invalidpublic static Minutes standardMinutesIn(ReadablePeriod period)
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 zeroIllegalArgumentException
 if the period contains imprecise duration valuespublic static Minutes parseMinutes(String periodStr)
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 nonzero. If any other component is nonzero, an exception will be thrown.
periodStr
 the period string, null returns zeroIllegalArgumentException
 if the string format is invalidpublic DurationFieldType getFieldType()
minutes
.getFieldType
in class BaseSingleFieldPeriod
public PeriodType getPeriodType()
minutes
.getPeriodType
in interface ReadablePeriod
getPeriodType
in class BaseSingleFieldPeriod
public Weeks toStandardWeeks()
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.
public Days toStandardDays()
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.
public Hours toStandardHours()
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.
public Seconds toStandardSeconds()
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 representedpublic Duration toStandardDuration()
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.
public int getMinutes()
public Minutes plus(int minutes)
This instance is immutable and unaffected by this method call.
minutes
 the amount of minutes to add, may be negativeArithmeticException
 if the result overflows an intpublic Minutes plus(Minutes minutes)
This instance is immutable and unaffected by this method call.
minutes
 the amount of minutes to add, may be negative, null means zeroArithmeticException
 if the result overflows an intpublic Minutes minus(int minutes)
This instance is immutable and unaffected by this method call.
minutes
 the amount of minutes to take away, may be negativeArithmeticException
 if the result overflows an intpublic Minutes minus(Minutes minutes)
This instance is immutable and unaffected by this method call.
minutes
 the amount of minutes to take away, may be negative, null means zeroArithmeticException
 if the result overflows an intpublic Minutes multipliedBy(int scalar)
This instance is immutable and unaffected by this method call.
scalar
 the amount to multiply by, may be negativeArithmeticException
 if the result overflows an intpublic Minutes dividedBy(int divisor)
This instance is immutable and unaffected by this method call.
divisor
 the amount to divide by, may be negativeArithmeticException
 if the divisor is zeropublic Minutes negated()
ArithmeticException
 if the result overflows an intpublic boolean isGreaterThan(Minutes other)
other
 the other period, null means zeropublic boolean isLessThan(Minutes other)
other
 the other period, null means zeropublic String toString()
For example, "PT4M" represents 4 minutes.
toString
in interface ReadablePeriod
toString
in class Object
Copyright © 2002–2024 Joda.org. All rights reserved.