/*
 *  Copyright 2001-2010 Stephen Colebourne
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.joda.time;

import org.joda.convert.FromString;
import org.joda.convert.ToString;
import org.joda.time.base.BaseSingleFieldPeriod;
import org.joda.time.field.FieldUtils;
import org.joda.time.format.ISOPeriodFormat;
import org.joda.time.format.PeriodFormatter;

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/**
 * An immutable time period representing a number of minutes.
 * <p>
 * <code>Minutes</code> 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.
 * <p>
 * The number of minutes is set in the constructor, and may be queried using
 * <code>getMinutes()</code>. Basic mathematical operations are provided -
 * <code>plus()</code>, <code>minus()</code>, <code>multipliedBy()</code> and
 * <code>dividedBy()</code>.
 * <p>
 * <code>Minutes</code> is thread-safe and immutable.
 *
 * @author Stephen Colebourne
 * @since 1.4
 */
public final class Minutes extends BaseSingleFieldPeriod {

    
Constant representing zero minutes. /** Constant representing zero minutes. */
    public static final Minutes ZERO = new Minutes(0);
    
Constant representing one minute. /** Constant representing one minute. */
    public static final Minutes ONE = new Minutes(1);
    
Constant representing two minutes. /** Constant representing two minutes. */
    public static final Minutes TWO = new Minutes(2);
    
Constant representing three minutes. /** Constant representing three minutes. */
    public static final Minutes THREE = new Minutes(3);
    
Constant representing the maximum number of minutes that can be stored in this object. /** Constant representing the maximum number of minutes that can be stored in this object. */
    public static final Minutes MAX_VALUE = new Minutes(Integer.MAX_VALUE);
    
Constant representing the minimum number of minutes that can be stored in this object. /** Constant representing the minimum number of minutes that can be stored in this object. */
    public static final Minutes MIN_VALUE = new Minutes(Integer.MIN_VALUE);

    
The parser to use for this class. /** The parser to use for this class. */
    private static final PeriodFormatter PARSER = ISOPeriodFormat.standard().withParseType(PeriodType.minutes());
    
Serialization version. /** Serialization version. */
    private static final long serialVersionUID = 87525275727380863L;

    //-----------------------------------------------------------------------
    
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.
Params:
minutes –  the number of minutes to obtain an instance for
Returns:
the instance of Minutes/**
     * Obtains an instance of <code>Minutes</code> that may be cached.
     * <code>Minutes</code> is immutable, so instances can be cached and shared.
     * This factory method provides access to shared instances.
     *
     * @param minutes  the number of minutes to obtain an instance for
     * @return the instance of Minutes
     */
    public static Minutes minutes(int minutes) {
        switch (minutes) {
            case 0:
                return ZERO;
            case 1:
                return ONE;
            case 2:
                return TWO;
            case 3:
                return THREE;
            case Integer.MAX_VALUE:
                return MAX_VALUE;
            case Integer.MIN_VALUE:
                return MIN_VALUE;
            default:
                return new Minutes(minutes);
        }
    }

    //-----------------------------------------------------------------------
    
Creates a Minutes representing the number of whole minutes
between the two specified datetimes.
Params:
start –  the start instant, must not be null
end –  the end instant, must not be null
Throws:
IllegalArgumentException – if the instants are null or invalid
Returns:
the period in minutes/**
     * Creates a <code>Minutes</code> representing the number of whole minutes
     * between the two specified datetimes.
     *
     * @param start  the start instant, must not be null
     * @param end  the end instant, must not be null
     * @return the period in minutes
     * @throws IllegalArgumentException if the instants are null or invalid
     */
    public static Minutes minutesBetween(ReadableInstant start, ReadableInstant end) {
        int amount = BaseSingleFieldPeriod.between(start, end, DurationFieldType.minutes());
        return Minutes.minutes(amount);
    }

    
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.
Params:
start –  the start partial date, must not be null
end –  the end partial date, must not be null
Throws:
IllegalArgumentException – if the partials are null or invalid
Returns:
the period in minutes/**
     * Creates a <code>Minutes</code> representing the number of whole minutes
     * between the two specified partial datetimes.
     * <p>
     * The two partials must contain the same fields, for example you can specify
     * two <code>LocalTime</code> objects.
     *
     * @param start  the start partial date, must not be null
     * @param end  the end partial date, must not be null
     * @return the period in minutes
     * @throws IllegalArgumentException if the partials are null or invalid
     */
    public static Minutes minutesBetween(ReadablePartial start, ReadablePartial end) {
        if (start instanceof LocalTime && end instanceof LocalTime)   {
            Chronology chrono = DateTimeUtils.getChronology(start.getChronology());
            int minutes = chrono.minutes().getDifference(
                    ((LocalTime) end).getLocalMillis(), ((LocalTime) start).getLocalMillis());
            return Minutes.minutes(minutes);
        }
        int amount = BaseSingleFieldPeriod.between(start, end, ZERO);
        return Minutes.minutes(amount);
    }

    
Creates a Minutes representing the number of whole minutes
in the specified interval.
Params:
interval –  the interval to extract minutes from, null returns zero
Throws:
IllegalArgumentException – if the partials are null or invalid
Returns:
the period in minutes/**
     * Creates a <code>Minutes</code> representing the number of whole minutes
     * in the specified interval.
     *
     * @param interval  the interval to extract minutes from, null returns zero
     * @return the period in minutes
     * @throws IllegalArgumentException if the partials are null or invalid
     */
    public static Minutes minutesIn(ReadableInterval interval) {
        if (interval == null)   {
            return Minutes.ZERO;
        }
        int amount = BaseSingleFieldPeriod.between(interval.getStart(), interval.getEnd(), DurationFieldType.minutes());
        return Minutes.minutes(amount);
    }

    
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.
Params:
period –  the period to get the number of minutes from, null returns zero
Throws:
IllegalArgumentException – if the period contains imprecise duration values
Returns:
the period in minutes/**
     * Creates a new <code>Minutes</code> representing the number of complete
     * standard length minutes in the specified period.
     * <p>
     * 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.
     * <ul>
     * <li>One week consists of 7 days.
     * <li>One day consists of 24 hours.
     * <li>One hour consists of 60 minutes.
     * <li>One minute consists of 60 seconds.
     * <li>One second consists of 1000 milliseconds.
     * </ul>
     * Months and Years are imprecise and periods containing these values cannot be converted.
     *
     * @param period  the period to get the number of minutes from, null returns zero
     * @return the period in minutes
     * @throws IllegalArgumentException if the period contains imprecise duration values
     */
    public static Minutes standardMinutesIn(ReadablePeriod period) {
        int amount = BaseSingleFieldPeriod.standardPeriodIn(period, DateTimeConstants.MILLIS_PER_MINUTE);
        return Minutes.minutes(amount);
    }

    
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.
Params:
periodStr –  the period string, null returns zero
Throws:
IllegalArgumentException – if the string format is invalid
Returns:
the period in minutes/**
     * Creates a new <code>Minutes</code> by parsing a string in the ISO8601 format 'PTnM'.
     * <p>
     * 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.
     *
     * @param periodStr  the period string, null returns zero
     * @return the period in minutes
     * @throws IllegalArgumentException if the string format is invalid
     */
    @FromString
    public static Minutes parseMinutes(String periodStr) {
        if (periodStr == null) {
            return Minutes.ZERO;
        }
        Period p = PARSER.parsePeriod(periodStr);
        return Minutes.minutes(p.getMinutes());
    }

    //-----------------------------------------------------------------------
    
Creates a new instance representing a number of minutes. You should consider using the factory method minutes(int) instead of the constructor. 
Params:
minutes –  the number of minutes to represent/**
     * Creates a new instance representing a number of minutes.
     * You should consider using the factory method {@link #minutes(int)}
     * instead of the constructor.
     *
     * @param minutes  the number of minutes to represent
     */
    private Minutes(int minutes) {
        super(minutes);
    }

    
Resolves singletons.
Returns:
the singleton instance/**
     * Resolves singletons.
     * 
     * @return the singleton instance
     */
    private Object readResolve() {
        return Minutes.minutes(getValue());
    }

    //-----------------------------------------------------------------------
    
Gets the duration field type, which is minutes.
Returns:
the period type/**
     * Gets the duration field type, which is <code>minutes</code>.
     *
     * @return the period type
     */
    public DurationFieldType getFieldType() {
        return DurationFieldType.minutes();
    }

    
Gets the period type, which is minutes.
Returns:
the period type/**
     * Gets the period type, which is <code>minutes</code>.
     *
     * @return the period type
     */
    public PeriodType getPeriodType() {
        return PeriodType.minutes();
    }

    //-----------------------------------------------------------------------
    
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/**
     * Converts this period in minutes to a period in weeks assuming a
     * 7 days week, 24 hour day and 60 minute hour.
     * <p>
     * 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.
     * 
     * @return a period representing the number of whole weeks for this number of minutes
     */
    public Weeks toStandardWeeks() {
        return Weeks.weeks(getValue() / DateTimeConstants.MINUTES_PER_WEEK);
    }

    
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/**
     * Converts this period in minutes to a period in days assuming a
     * 24 hour day and 60 minute hour.
     * <p>
     * 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.
     * 
     * @return a period representing the number of whole days for this number of minutes
     */
    public Days toStandardDays() {
        return Days.days(getValue() / DateTimeConstants.MINUTES_PER_DAY);
    }

    
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/**
     * Converts this period in minutes to a period in hours assuming a
     * 60 minute hour.
     * <p>
     * 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.
     * 
     * @return a period representing the number of hours for this number of minutes
     */
    public Hours toStandardHours() {
        return Hours.hours(getValue() / DateTimeConstants.MINUTES_PER_HOUR);
    }

    
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.
Throws:
ArithmeticException – if the number of seconds is too large to be represented
Returns:
a period representing the number of seconds for this number of minutes/**
     * Converts this period in minutes to a period in seconds assuming a
     * 60 second minute.
     * <p>
     * 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.
     * 
     * @return 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
     */
    public Seconds toStandardSeconds() {
        return Seconds.seconds(FieldUtils.safeMultiply(getValue(), DateTimeConstants.SECONDS_PER_MINUTE));
    }

    //-----------------------------------------------------------------------
    
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/**
     * Converts this period in minutes to a duration in milliseconds assuming a
     * 60 second minute.
     * <p>
     * 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.
     *
     * @return a duration equivalent to this number of minutes
     */
    public Duration toStandardDuration() {
        long minutes = getValue();  // assign to a long
        return new Duration(minutes * DateTimeConstants.MILLIS_PER_MINUTE);
    }

    //-----------------------------------------------------------------------
    
Gets the number of minutes that this period represents.
Returns:
the number of minutes in the period/**
     * Gets the number of minutes that this period represents.
     *
     * @return the number of minutes in the period
     */
    public int getMinutes() {
        return getValue();
    }

    //-----------------------------------------------------------------------
    
Returns a new instance with the specified number of minutes added.

This instance is immutable and unaffected by this method call.
Params:
minutes –  the amount of minutes to add, may be negative
Throws:
ArithmeticException – if the result overflows an int
Returns:
the new period plus the specified number of minutes/**
     * Returns a new instance with the specified number of minutes added.
     * <p>
     * This instance is immutable and unaffected by this method call.
     *
     * @param minutes  the amount of minutes to add, may be negative
     * @return the new period plus the specified number of minutes
     * @throws ArithmeticException if the result overflows an int
     */
    public Minutes plus(int minutes) {
        if (minutes == 0) {
            return this;
        }
        return Minutes.minutes(FieldUtils.safeAdd(getValue(), minutes));
    }

    
Returns a new instance with the specified number of minutes added.

This instance is immutable and unaffected by this method call.
Params:
minutes –  the amount of minutes to add, may be negative, null means zero
Throws:
ArithmeticException – if the result overflows an int
Returns:
the new period plus the specified number of minutes/**
     * Returns a new instance with the specified number of minutes added.
     * <p>
     * This instance is immutable and unaffected by this method call.
     *
     * @param minutes  the amount of minutes to add, may be negative, null means zero
     * @return the new period plus the specified number of minutes
     * @throws ArithmeticException if the result overflows an int
     */
    public Minutes plus(Minutes minutes) {
        if (minutes == null) {
            return this;
        }
        return plus(minutes.getValue());
    }

    //-----------------------------------------------------------------------
    
Returns a new instance with the specified number of minutes taken away.

This instance is immutable and unaffected by this method call.
Params:
minutes –  the amount of minutes to take away, may be negative
Throws:
ArithmeticException – if the result overflows an int
Returns:
the new period minus the specified number of minutes/**
     * Returns a new instance with the specified number of minutes taken away.
     * <p>
     * This instance is immutable and unaffected by this method call.
     *
     * @param minutes  the amount of minutes to take away, may be negative
     * @return the new period minus the specified number of minutes
     * @throws ArithmeticException if the result overflows an int
     */
    public Minutes minus(int minutes) {
        return plus(FieldUtils.safeNegate(minutes));
    }

    
Returns a new instance with the specified number of minutes taken away.

This instance is immutable and unaffected by this method call.
Params:
minutes –  the amount of minutes to take away, may be negative, null means zero
Throws:
ArithmeticException – if the result overflows an int
Returns:
the new period minus the specified number of minutes/**
     * Returns a new instance with the specified number of minutes taken away.
     * <p>
     * This instance is immutable and unaffected by this method call.
     *
     * @param minutes  the amount of minutes to take away, may be negative, null means zero
     * @return the new period minus the specified number of minutes
     * @throws ArithmeticException if the result overflows an int
     */
    public Minutes minus(Minutes minutes) {
        if (minutes == null) {
            return this;
        }
        return minus(minutes.getValue());
    }

    //-----------------------------------------------------------------------
    
Returns a new instance with the minutes multiplied by the specified scalar.

This instance is immutable and unaffected by this method call.
Params:
scalar –  the amount to multiply by, may be negative
Throws:
ArithmeticException – if the result overflows an int
Returns:
the new period multiplied by the specified scalar/**
     * Returns a new instance with the minutes multiplied by the specified scalar.
     * <p>
     * This instance is immutable and unaffected by this method call.
     *
     * @param scalar  the amount to multiply by, may be negative
     * @return the new period multiplied by the specified scalar
     * @throws ArithmeticException if the result overflows an int
     */
    public Minutes multipliedBy(int scalar) {
        return Minutes.minutes(FieldUtils.safeMultiply(getValue(), scalar));
    }

    
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.
Params:
divisor –  the amount to divide by, may be negative
Throws:
ArithmeticException – if the divisor is zero
Returns:
the new period divided by the specified 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.
     * <p>
     * This instance is immutable and unaffected by this method call.
     *
     * @param divisor  the amount to divide by, may be negative
     * @return the new period divided by the specified divisor
     * @throws ArithmeticException if the divisor is zero
     */
    public Minutes dividedBy(int divisor) {
        if (divisor == 1) {
            return this;
        }
        return Minutes.minutes(getValue() / divisor);
    }

    //-----------------------------------------------------------------------
    
Returns a new instance with the minutes value negated.
Throws:
ArithmeticException – if the result overflows an int
Returns:
the new period with a negated value/**
     * Returns a new instance with the minutes value negated.
     *
     * @return the new period with a negated value
     * @throws ArithmeticException if the result overflows an int
     */
    public Minutes negated() {
        return Minutes.minutes(FieldUtils.safeNegate(getValue()));
    }

    //-----------------------------------------------------------------------
    
Is this minutes instance greater than the specified number of minutes.
Params:
other –  the other period, null means zero
Returns:
true if this minutes instance is greater than the specified one/**
     * Is this minutes instance greater than the specified number of minutes.
     *
     * @param other  the other period, null means zero
     * @return true if this minutes instance is greater than the specified one
     */
    public boolean isGreaterThan(Minutes other) {
        if (other == null) {
            return getValue() > 0;
        }
        return getValue() > other.getValue();
    }

    
Is this minutes instance less than the specified number of minutes.
Params:
other –  the other period, null means zero
Returns:
true if this minutes instance is less than the specified one/**
     * Is this minutes instance less than the specified number of minutes.
     *
     * @param other  the other period, null means zero
     * @return true if this minutes instance is less than the specified one
     */
    public boolean isLessThan(Minutes other) {
        if (other == null) {
            return getValue() < 0;
        }
        return getValue() < other.getValue();
    }

    //-----------------------------------------------------------------------
    
Gets this instance as a String in the ISO8601 duration format.

For example, "PT4M" represents 4 minutes.
Returns:
the value as an ISO8601 string/**
     * Gets this instance as a String in the ISO8601 duration format.
     * <p>
     * For example, "PT4M" represents 4 minutes.
     *
     * @return the value as an ISO8601 string
     */
    @ToString
    public String toString() {
        return "PT" + String.valueOf(getValue()) + "M";
    }

}