Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   *  Copyright 2001-2006 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.goda.time;
 
An immutable time period representing a number of days.

Days is an immutable period that can only store days. It does not store years, months or hours for example. As such it is a type-safe way of representing a number of days in an application.

The number of days is set in the constructor, and may be queried using getDays(). Basic mathematical operations are provided - plus(), minus(), multipliedBy() and dividedBy().

Days is thread-safe and immutable.

Author(s):
Stephen Colebourne
Since:
1.4
 
 public final class Days extends BaseSingleFieldPeriod {

    
Constant representing zero days.
 
     public static final Days ZERO = new Days(0);
    
Constant representing one day.
 
     public static final Days ONE = new Days(1);
    
Constant representing two days.
 
     public static final Days TWO = new Days(2);
    
Constant representing three days.
 
     public static final Days THREE = new Days(3);
    
Constant representing four days.
 
     public static final Days FOUR = new Days(4);
    
Constant representing five days.
 
     public static final Days FIVE = new Days(5);
    
Constant representing six days.
 
     public static final Days SIX = new Days(6);
    
Constant representing seven days.
 
     public static final Days SEVEN = new Days(7);
    
Constant representing the maximum number of days that can be stored in this object.
 
     public static final Days MAX_VALUE = new Days(.);
    
Constant representing the minimum number of days that can be stored in this object.
 
     public static final Days MIN_VALUE = new Days(.);

    
The paser to use for this class.
 
     private static final PeriodFormatter PARSER = ISOPeriodFormat.standard().withParseType(PeriodType.days());
    
Serialization version.
 
     private static final long serialVersionUID = 87525275727380865L;
 
     //-----------------------------------------------------------------------
     
Obtains an instance of Days that may be cached. Days is immutable, so instances can be cached and shared. This factory method provides access to shared instances.

Parameters:
days the number of days to obtain an instance for
Returns:
the instance of Days
 
     public static Days days(int days) {
         switch (days) {
             case 0:
                 return ;
             case 1:
                 return ;
             case 2:
                 return ;
             case 3:
                 return ;
             case 4:
                 return ;
             case 5:
                 return ;
             case 6:
                 return ;
             case 7:
                 return ;
             case .:
                 return ;
             case .:
                 return ;
             default:
                return new Days(days);
        }
    }
    //-----------------------------------------------------------------------
    
Creates a Days representing the number of whole days between the two specified datetimes. This method corectly handles any daylight savings time changes that may occur during the interval.

Parameters:
start the start instant, must not be null
end the end instant, must not be null
Returns:
the period in days
Throws:
java.lang.IllegalArgumentException if the instants are null or invalid
    public static Days daysBetween(ReadableInstant startReadableInstant end) {
        int amount = BaseSingleFieldPeriod.between(startend, DurationFieldType.days());
        return Days.days(amount);
    }

    
Creates a Days representing the number of whole days between the two specified partial datetimes.

The two partials must contain the same fields, for example you can specify two LocalDate objects.

Parameters:
start the start partial date, must not be null
end the end partial date, must not be null
Returns:
the period in days
Throws:
java.lang.IllegalArgumentException if the partials are null or invalid
    public static Days daysBetween(ReadablePartial startReadablePartial end) {
        if (start instanceof LocalDate && end instanceof LocalDate)   {
            Chronology chrono = DateTimeUtils.getChronology(start.getChronology());
            int days = chrono.days().getDifference(
                    ((LocalDateend).getLocalMillis(), ((LocalDatestart).getLocalMillis());
            return Days.days(days);
        }
        int amount = BaseSingleFieldPeriod.between(startend);
        return Days.days(amount);
    }

    
Creates a Days representing the number of whole days in the specified interval. This method corectly handles any daylight savings time changes that may occur during the interval.

Parameters:
interval the interval to extract days from, null returns zero
Returns:
the period in days
Throws:
java.lang.IllegalArgumentException if the partials are null or invalid
    public static Days daysIn(ReadableInterval interval) {
        if (interval == null)   {
            return .;
        }
        int amount = BaseSingleFieldPeriod.between(interval.getStart(), interval.getEnd(), DurationFieldType.days());
        return Days.days(amount);
    }

    
Creates a new Days representing the number of complete standard length days in the specified period.

This factory method converts all fields from the period to hours 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 hours from, null returns zero
Returns:
the period in days
Throws:
java.lang.IllegalArgumentException if the period contains imprecise duration values
    public static Days standardDaysIn(ReadablePeriod period) {
        int amount = BaseSingleFieldPeriod.standardPeriodIn(period.);
        return Days.days(amount);
    }

    
Creates a new Days by parsing a string in the ISO8601 format 'PnD'.

The parse will accept the full ISO syntax of PnYnMnWnDTnHnMnS however only the days 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
Returns:
the period in days
Throws:
java.lang.IllegalArgumentException if the string format is invalid
    public static Days parseDays(String periodStr) {
        if (periodStr == null) {
            return .;
        }
        Period p = .parsePeriod(periodStr);
        return Days.days(p.getDays());
    }
    //-----------------------------------------------------------------------
    
Creates a new instance representing a number of days. You should consider using the factory method days(int) instead of the constructor.

Parameters:
days the number of days to represent
    private Days(int days) {
        super(days);
    }

    
Resolves singletons.

Returns:
the singleton instance
    private Object readResolve() {
        return Days.days(getValue());
    }
    //-----------------------------------------------------------------------
    
Gets the duration field type, which is days.

Returns:
the period type
    public DurationFieldType getFieldType() {
        return DurationFieldType.days();
    }

    
Gets the period type, which is days.

Returns:
the period type
    public PeriodType getPeriodType() {
        return PeriodType.days();
    }
    //-----------------------------------------------------------------------
    
Converts this period in days to a period in weeks assuming a 7 day week.

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. 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 weeks for this number of days
    public Weeks toStandardWeeks() {
        return Weeks.weeks(getValue() / .);
    }

    
Converts this period in days to a period in hours assuming a 24 hour day.

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. 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 hours for this number of days
Throws:
java.lang.ArithmeticException if the number of hours is too large to be represented
    public Hours toStandardHours() {
        return Hours.hours(FieldUtils.safeMultiply(getValue(), .));
    }

    
Converts this period in days to a period in minutes 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 minutes for this number of days
Throws:
java.lang.ArithmeticException if the number of minutes is too large to be represented
    public Minutes toStandardMinutes() {
        return Minutes.minutes(FieldUtils.safeMultiply(getValue(), .));
    }

    
Converts this period in days to a period in seconds assuming a 24 hour day, 60 minute hour and 60 second minute.

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, all hours are 60 minutes long and all minutes are 60 seconds 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 seconds for this number of days
Throws:
java.lang.ArithmeticException if the number of seconds is too large to be represented
    public Seconds toStandardSeconds() {
        return Seconds.seconds(FieldUtils.safeMultiply(getValue(), .));
    }
    //-----------------------------------------------------------------------
    
Converts this period in days to a duration in milliseconds assuming a 24 hour day, 60 minute hour and 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 days are 24 hours long, all hours are 60 minutes and all minutes are 60 seconds. This is not true when daylight savings time 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 duration equivalent to this number of days
    public Duration toStandardDuration() {
        long days = getValue();  // assign to a long
        return new Duration(days * .);
    }
    //-----------------------------------------------------------------------
    
Gets the number of days that this period represents.

Returns:
the number of days in the period
    public int getDays() {
        return getValue();
    }
    //-----------------------------------------------------------------------
    
Returns a new instance with the specified number of days added.

This instance is immutable and unaffected by this method call.

Parameters:
days the amount of days to add, may be negative
Returns:
the new period plus the specified number of days
Throws:
java.lang.ArithmeticException if the result overflows an int
    public Days plus(int days) {
        if (days == 0) {
            return this;
        }
        return Days.days(FieldUtils.safeAdd(getValue(), days));
    }

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

This instance is immutable and unaffected by this method call.

Parameters:
days the amount of days to add, may be negative, null means zero
Returns:
the new period plus the specified number of days
Throws:
java.lang.ArithmeticException if the result overflows an int
    public Days plus(Days days) {
        if (days == null) {
            return this;
        }
        return plus(days.getValue());
    }
    //-----------------------------------------------------------------------
    
Returns a new instance with the specified number of days taken away.

This instance is immutable and unaffected by this method call.

Parameters:
days the amount of days to take away, may be negative
Returns:
the new period minus the specified number of days
Throws:
java.lang.ArithmeticException if the result overflows an int
    public Days minus(int days) {
        return plus(FieldUtils.safeNegate(days));
    }

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

This instance is immutable and unaffected by this method call.

Parameters:
days the amount of days to take away, may be negative, null means zero
Returns:
the new period minus the specified number of days
Throws:
java.lang.ArithmeticException if the result overflows an int
    public Days minus(Days days) {
        if (days == null) {
            return this;
        }
        return minus(days.getValue());
    }
    //-----------------------------------------------------------------------
    
Returns a new instance with the days 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
    public Days multipliedBy(int scalar) {
        return Days.days(FieldUtils.safeMultiply(getValue(), scalar));
    }

    
Returns a new instance with the days 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
    public Days dividedBy(int divisor) {
        if (divisor == 1) {
            return this;
        }
        return Days.days(getValue() / divisor);
    }
    //-----------------------------------------------------------------------
    
Returns a new instance with the days value negated.

Returns:
the new period with a negated value
Throws:
java.lang.ArithmeticException if the result overflows an int
    public Days negated() {
        return Days.days(FieldUtils.safeNegate(getValue()));
    }
    //-----------------------------------------------------------------------
    
Is this days instance greater than the specified number of days.

Parameters:
other the other period, null means zero
Returns:
true if this days instance is greater than the specified one
    public boolean isGreaterThan(Days other) {
        if (other == null) {
            return getValue() > 0;
        }
        return getValue() > other.getValue();
    }

    
Is this days instance less than the specified number of days.

Parameters:
other the other period, null means zero
Returns:
true if this days instance is less than the specified one
    public boolean isLessThan(Days other) {
        if (other == null) {
            return getValue() < 0;
        }
        return getValue() < other.getValue();
    }
    //-----------------------------------------------------------------------
    
Gets this instance as a String in the ISO8601 duration format.

For example, "P4D" represents 4 days.

Returns:
the value as an ISO8601 string
    public String toString() {
        return "P" + String.valueOf(getValue()) + "D";
    }
New to GrepCode? Check out our FAQ X