Java Doc for LocalDate.java in  » Development » Joda-Time » org » joda » time » Java Source Code / Java DocumentationJava Source Code and Java Documentation

LocalDate implements the ReadablePartial interface. To do this, the interface methods focus on the key fields - Year, MonthOfYear and DayOfMonth. However, all date fields may in fact be queried.

LocalDate differs from DateMidnight in that this class does not have a time zone and does not represent a single instant in time.

Calculations on LocalDate are performed using a Chronology . This chronology will be set internally to be in the UTC time zone for all calculations.

Each individual field can be queried in two ways:

• getMonthOfYear()
• monthOfYear().get()

• numeric value
• text value
• short text value
• maximum/minimum values
• add/subtract
• set
• rounding

LocalDate is thread-safe and immutable, provided that the Chronology is as well. All standard Chronology classes supplied are thread-safe and immutable.
author:
   Stephen Colebourne
since:
   1.3

Each field is queried from the Calendar and assigned to the LocalDate. This is useful if you have been using the Calendar as a local date, ignoing the zone.

This factory method ignores the type of the calendar and always creates a LocalDate with ISO chronology.

This method is required to support the ReadablePartial interface.

The weekyear is the year that matches with the weekOfWeekyear field. In the standard ISO8601 week algorithm, the first week of the year is that in which at least 4 days are in the year.

As from v1.5, you are recommended to avoid DateMidnight and use LocalDate.toDateTimeAtStartOfDay() instead because of the exception detailed below.

This method will throw an exception if the default time zone switches to Daylight Savings Time at midnight and this LocalDate represents that switchover date.

As from v1.5, you are recommended to avoid DateMidnight and use LocalDate.toDateTimeAtStartOfDay() instead because of the exception detailed below.

This method will throw an exception if the time zone switches to Daylight Savings Time at midnight and this LocalDate represents that switchover date.

The resulting chronology is determined by the chronology of this LocalDate.

The resulting chronology is determined by the chronology of this LocalDate plus the time zone.

This method will throw an exception if the default time zone switches to Daylight Savings Time at midnight and this LocalDate represents that switchover date.

This method will throw an exception if the time zone switches to Daylight Savings Time at midnight and this LocalDate represents that switchover date.

The time will normally be midnight, as that is the earliest time on any given day.

The time will normally be midnight, as that is the earliest time on any given day.

The resulting chronology is determined by the chronology of this LocalDate.

If the addition is zero, then this is returned.

This method is typically used to add multiple copies of complex period instances.

Once the constructor is completed, the zone is no longer used.

If the specified time zone is null, the default zone is used. Once the constructor is completed, the zone is no longer used.
Parameters:
  zone - the time zone, null means default zone

If the chronology is null, ISO chronology in the default time zone is used. Once the constructor is completed, the zone is no longer used.
Parameters:
  chronology - the chronology, null means ISOChronology in default zone

Once the constructor is completed, the zone is no longer used.
Parameters:
  instant - the milliseconds from 1970-01-01T00:00:00Z

If the specified time zone is null, the default zone is used. Once the constructor is completed, the zone is no longer used.
Parameters:
  instant - the milliseconds from 1970-01-01T00:00:00Z
Parameters:
  zone - the time zone, null means default zone

If the chronology is null, ISO chronology in the default zone is used. Once the constructor is completed, the zone is no longer used.
Parameters:
  instant - the milliseconds from 1970-01-01T00:00:00Z
Parameters:
  chronology - the chronology, null means ISOChronology in default zone

If the object contains no chronology, ISOChronology is used. Once the constructor is completed, the zone is no longer used.

The recognised object types are defined in org.joda.time.convert.ConverterManager ConverterManager and include ReadablePartial, ReadableInstant, String, Calendar and Date. The String formats are described by ISODateTimeFormat.localDateParser . The default String converter ignores the zone and only parses the field values.
Parameters:
  instant - the datetime object
throws:
  IllegalArgumentException - if the instant is invalid

If the object contains no chronology, ISOChronology is used. If the specified time zone is null, the default zone is used. Once the constructor is completed, the zone is no longer used.

The recognised object types are defined in org.joda.time.convert.ConverterManager ConverterManager and include ReadablePartial, ReadableInstant, String, Calendar and Date. The String formats are described by ISODateTimeFormat.localDateParser . The default String converter ignores the zone and only parses the field values.
Parameters:
  instant - the datetime object
Parameters:
  zone - the time zone
throws:
  IllegalArgumentException - if the instant is invalid

If the chronology is null, ISO in the default time zone is used. Once the constructor is completed, the zone is no longer used.

The recognised object types are defined in org.joda.time.convert.ConverterManager ConverterManager and include ReadablePartial, ReadableInstant, String, Calendar and Date. The String formats are described by ISODateTimeFormat.localDateParser . The default String converter ignores the zone and only parses the field values.
Parameters:
  instant - the datetime object
Parameters:
  chronology - the chronology
throws:
  IllegalArgumentException - if the instant is invalid

If the chronology is null, ISOChronology is used.
Parameters:
  year - the year
Parameters:
  monthOfYear - the month of the year
Parameters:
  dayOfMonth - the day of the month
Parameters:
  chronology - the chronology, null means ISOChronology in default zone

The fields are compared in order, from largest to smallest. The first field that is non-equal is used to determine the result.

The specified object must be a partial instance whose field types match those of this partial.

NOTE: This implementation violates the Comparable contract. This method will accept any instance of ReadablePartial as input. However, it is possible that some implementations of ReadablePartial exist that do not extend AbstractPartial, and thus will throw a ClassCastException if compared in the opposite direction. The cause of this problem is that ReadablePartial doesn't define the compareTo() method, however we can't change that until v2.0.
Parameters:
  partial - an object to check against negative if this is less, zero if equal, positive if greater
throws:
  ClassCastException - if the partial is the wrong classor if it has field types that don't match
throws:
  NullPointerException - if the partial is null

Each field is queried from the Calendar and assigned to the LocalDate. This is useful if you have been using the Calendar as a local date, ignoing the zone.

This factory method ignores the type of the calendar and always creates a LocalDate with ISO chronology. It is expected that you will only pass in instances of GregorianCalendar however this is not validated.
Parameters:
  calendar - the Calendar to extract fields from the created LocalDate
throws:
  IllegalArgumentException - if the calendar is null
throws:
  IllegalArgumentException - if the date is invalid for the ISO chronology

Each field is queried from the Date and assigned to the LocalDate. This is useful if you have been using the Date as a local date, ignoing the zone.

This factory method always creates a LocalDate with ISO chronology.
Parameters:
  date - the Date to extract fields from the created LocalDate
throws:
  IllegalArgumentException - if the calendar is null
throws:
  IllegalArgumentException - if the date is invalid for the ISO chronology

This method gets the value of the specified field. For example:

 LocalDate dt = LocalDate.nowDefaultZone();
 int year = dt.get(DateTimeFieldType.year());
 

The values for the day of month are defined in org.joda.time.DateTimeConstants . the day of month

The values for the day of week are defined in org.joda.time.DateTimeConstants . the day of week

This method must not use any instance variables.
Parameters:
  index - the index to retrieve
Parameters:
  chrono - the chronology to use the field

This method is required to support the ReadablePartial interface. The supported fields are Year, MonthOfYear and DayOfMonth. Note that all fields from day and above may in fact be queried via other methods.
Parameters:
  index - the index, zero to two the value
throws:
  IndexOutOfBoundsException - if the index is invalid

The weekyear is the year that matches with the weekOfWeekyear field. In the standard ISO8601 week algorithm, the first week of the year is that in which at least 4 days are in the year. As a result of this definition, day 1 of the first week may be in the previous year. The weekyear allows you to query the effective year for that day. the weekyear

If the amount is zero or null, then this is returned.

This method is typically used to subtract complex period instances. Subtracting one field is best achieved using methods like LocalDate.minusYears(int) .

Unsupported time fields are ignored, thus subtracting a period of 24 hours will not have any effect.
Parameters:
  period - the period to reduce this instant by a copy of this LocalDate with the period taken away
throws:
  ArithmeticException - if the result exceeds the internal capacity

This LocalDate instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalDate subtracted = dt.minusDays(6);
 LocalDate subtracted = dt.minus(Period.days(6));
 LocalDate subtracted = dt.withFieldAdded(DurationFieldType.days(), -6);
 

This LocalDate instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalDate subtracted = dt.minusMonths(6);
 LocalDate subtracted = dt.minus(Period.months(6));
 LocalDate subtracted = dt.withFieldAdded(DurationFieldType.months(), -6);
 

This LocalDate instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalDate subtracted = dt.minusWeeks(6);
 LocalDate subtracted = dt.minus(Period.weeks(6));
 LocalDate subtracted = dt.withFieldAdded(DurationFieldType.weeks(), -6);
 

This LocalDate instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalDate subtracted = dt.minusYears(6);
 LocalDate subtracted = dt.minus(Period.years(6));
 LocalDate subtracted = dt.withFieldAdded(DurationFieldType.years(), -6);
 

If the amount is zero or null, then this is returned.

This method is typically used to add complex period instances. Adding one field is best achieved using methods like LocalDate.plusYears(int) .

Unsupported time fields are ignored, thus adding a period of 24 hours will not have any effect.
Parameters:
  period - the period to add to this one, null means zero a copy of this date with the period added
throws:
  ArithmeticException - if the result exceeds the internal capacity

This LocalDate instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalDate added = dt.plusDays(6);
 LocalDate added = dt.plus(Period.days(6));
 LocalDate added = dt.withFieldAdded(DurationFieldType.days(), 6);
 

This LocalDate instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalDate added = dt.plusMonths(6);
 LocalDate added = dt.plus(Period.months(6));
 LocalDate added = dt.withFieldAdded(DurationFieldType.months(), 6);
 

This LocalDate instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalDate added = dt.plusWeeks(6);
 LocalDate added = dt.plus(Period.weeks(6));
 LocalDate added = dt.withFieldAdded(DurationFieldType.weeks(), 6);
 

This LocalDate instance is immutable and unaffected by this method call.

The following three lines are identical in effect:

 LocalDate added = dt.plusYears(6);
 LocalDate added = dt.plus(Period.years(6));
 LocalDate added = dt.withFieldAdded(DurationFieldType.years(), 6);
 

As from v1.5, you are recommended to avoid DateMidnight and use LocalDate.toDateTimeAtStartOfDay() instead because of the exception detailed below.

This method will throw an exception if the default time zone switches to Daylight Savings Time at midnight and this LocalDate represents that switchover date. The problem is that there is no such time as midnight on the required date, and as such an exception is thrown.

This instance is immutable and unaffected by this method call. the DateMidnight instance in the default zone

As from v1.5, you are recommended to avoid DateMidnight and use LocalDate.toDateTimeAtStartOfDay() instead because of the exception detailed below.

This method will throw an exception if the time zone switches to Daylight Savings Time at midnight and this LocalDate represents that switchover date. The problem is that there is no such time as midnight on the required date, and as such an exception is thrown.

This instance is immutable and unaffected by this method call.
Parameters:
  zone - the zone to get the DateMidnight in, null means default zone the DateMidnight instance

The resulting chronology is determined by the chronology of this LocalDate. The chronology of the time must match. If the time is null, the current time in the date's chronology is used.

This method will throw an exception if the datetime that would be created does not exist when the time zone is taken into account.

This instance is immutable and unaffected by this method call.
Parameters:
  time - the time of day to use, null means current time the DateTime instance
throws:
  IllegalArgumentException - if the chronology of the time does not match

The resulting chronology is determined by the chronology of this LocalDate plus the time zone. The chronology of the time must match. If the time is null, the current time in the date's chronology is used.

This method will throw an exception if the datetime that would be created does not exist when the time zone is taken into account.

This instance is immutable and unaffected by this method call.
Parameters:
  time - the time of day to use, null means current time
Parameters:
  zone - the zone to get the DateTime in, null means default the DateTime instance
throws:
  IllegalArgumentException - if the chronology of the time does not match

This method will throw an exception if the datetime that would be created does not exist when the time zone is taken into account.

This instance is immutable and unaffected by this method call. this date as a datetime with the time as the current time

This method uses the chronology from this instance plus the time zone specified.

This method will throw an exception if the datetime that would be created does not exist when the time zone is taken into account.

This instance is immutable and unaffected by this method call.
Parameters:
  zone - the zone to use, null means default zone this date as a datetime with the time as the current time

This method will throw an exception if the default time zone switches to Daylight Savings Time at midnight and this LocalDate represents that switchover date. The problem is that there is no such time as midnight on the required date, and as such an exception is thrown.

This instance is immutable and unaffected by this method call. this date as a datetime at midnightLocalDate.toDateTimeAtStartOfDay()

This method will throw an exception if the time zone switches to Daylight Savings Time at midnight and this LocalDate represents that switchover date. The problem is that there is no such time as midnight on the required date, and as such an exception is thrown.

This method uses the chronology from this instance plus the time zone specified.

This instance is immutable and unaffected by this method call.
Parameters:
  zone - the zone to use, null means default zone this date as a datetime at midnightLocalDate.toDateTimeAtStartOfDay(DateTimeZone)

The time will normally be midnight, as that is the earliest time on any given day. However, in some time zones when Daylight Savings Time starts, there is no midnight because time jumps from 11:59 to 01:00. This method handles that situation by returning 01:00 on that date.

This instance is immutable and unaffected by this method call. this date as a datetime at the start of the day
since:
   1.5

The time will normally be midnight, as that is the earliest time on any given day. However, in some time zones when Daylight Savings Time starts, there is no midnight because time jumps from 11:59 to 01:00. This method handles that situation by returning 01:00 on that date.

This method uses the chronology from this instance plus the time zone specified.

This instance is immutable and unaffected by this method call.
Parameters:
  zone - the zone to use, null means default zone this date as a datetime at the start of the day
since:
   1.5

This instance is immutable and unaffected by this method call. a interval over the day

This instance is immutable and unaffected by this method call.
Parameters:
  zone - the zone to get the Interval in, null means default a interval over the day

The resulting chronology is determined by the chronology of this LocalDate. The chronology of the time must also match. If the time is null an exception is thrown.

This instance is immutable and unaffected by this method call.
Parameters:
  time - the time of day to use, must not be null the LocalDateTime instance
throws:
  IllegalArgumentException - if the time is null
throws:
  IllegalArgumentException - if the chronology of the time does not match
since:
   1.5

LocalDate is immutable, so there are no set methods. Instead, this method returns a new instance with the value of century of era changed.
Parameters:
  centuryOfEra - the centurey of era to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

LocalDate is immutable, so there are no set methods. Instead, this method returns a new instance with the value of day of month changed.
Parameters:
  dayOfMonth - the day of month to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

LocalDate is immutable, so there are no set methods. Instead, this method returns a new instance with the value of day of week changed.
Parameters:
  dayOfWeek - the day of week to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

LocalDate is immutable, so there are no set methods. Instead, this method returns a new instance with the value of day of year changed.
Parameters:
  dayOfYear - the day of year to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

LocalDate is immutable, so there are no set methods. Instead, this method returns a new instance with the value of era changed.
Parameters:
  era - the era to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

For example, if the field type is monthOfYear then the month of year field will be changed in the returned instance. If the field type is null, then this is returned.

These two lines are equivalent:

 LocalDate updated = dt.withDayOfMonth(6);
 LocalDate updated = dt.withField(DateTimeFieldType.dayOfMonth(), 6);
 

If the addition is zero or the field is null, then this is returned.

These three lines are equivalent:

 LocalDate added = dt.withFieldAdded(DurationFieldType.years(), 6);
 LocalDate added = dt.plusYears(6);
 LocalDate added = dt.plus(Period.years(6));
 

For example, if the partial contains a year and a month then those two fields will be changed in the returned instance. Unsupported fields are ignored. If the partial is null, then this is returned.
Parameters:
  partial - the partial set of fields to apply to this date, null ignored a copy of this date with a different set of fields
throws:
  IllegalArgumentException - if any value is invalid

The returned object will be a new instance of the same type. Only the millis will change, the chronology is kept. The returned object will be either be a new instance or this.
Parameters:
  newMillis - the new millis, from 1970-01-01T00:00:00 a copy of this date with different millis

LocalDate is immutable, so there are no set methods. Instead, this method returns a new instance with the value of month of year changed.
Parameters:
  monthOfYear - the month of year to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

If the addition is zero, then this is returned.

This method is typically used to add multiple copies of complex period instances. Adding one field is best achieved using methods like LocalDate.withFieldAdded(DurationFieldType,int) or LocalDate.plusYears(int) .

Unsupported time fields are ignored, thus adding a period of 24 hours will not have any effect.
Parameters:
  period - the period to add to this one, null means zero
Parameters:
  scalar - the amount of times to add, such as -1 to subtract once a copy of this date with the period added
throws:
  ArithmeticException - if the result exceeds the internal capacity

LocalDate is immutable, so there are no set methods. Instead, this method returns a new instance with the value of week of weekyear changed.
Parameters:
  weekOfWeekyear - the week of weekyear to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

LocalDate is immutable, so there are no set methods. Instead, this method returns a new instance with the value of weekyear changed.
Parameters:
  weekyear - the weekyear to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

LocalDate is immutable, so there are no set methods. Instead, this method returns a new instance with the value of year changed.
Parameters:
  year - the year to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

LocalDate is immutable, so there are no set methods. Instead, this method returns a new instance with the value of year of century changed.
Parameters:
  yearOfCentury - the year of century to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid

LocalDate is immutable, so there are no set methods. Instead, this method returns a new instance with the value of year of era changed.
Parameters:
  yearOfEra - the year of era to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the value is invalid