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

LocalDateTime implements the ReadablePartial interface. To do this, certain methods focus on key fields Year, MonthOfYear, DayOfYear and MillisOfDay. However, all fields may in fact be queried.

Internally, LocalDateTime uses a single millisecond-based value to represent the local datetime. This value is only used internally and is not exposed to applications.

Calculations on LocalDateTime 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:

• getHourOfDay()
• hourOfDay().get()

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

LocalDateTime 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 LocalDateTime. 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 LocalDateTime 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.

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. If the object contains no time zone, 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.localDateOptionalTimeParser . 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.localDateOptionalTimeParser . 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.localDateOptionalTimeParser . 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:
  hourOfDay - the hour of the day
Parameters:
  minuteOfHour - the minute of the hour
Parameters:
  secondOfMinute - the second of the minute
Parameters:
  millisOfSecond - the millisecond of the second
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 LocalDateTime. 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 LocalDateTime 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 LocalDateTime
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 LocalDateTime. This is useful if you have been using the Date as a local date, ignoing the zone.

This factory method always creates a LocalDateTime with ISO chronology.
Parameters:
  date - the Date to extract fields from the created LocalDateTime
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:

 DateTime dt = new DateTime();
 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, MonthOfDay, DayOfMonth and MillisOfDay.
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.
Parameters:
  duration - the duration to reduce this instant by a copy of this datetime with the duration taken away
throws:
  ArithmeticException - if the result exceeds the internal capacity

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 LocalDateTime.minusYears(int) .
Parameters:
  period - the period to reduce this instant by a copy of this datetime with the period taken away
throws:
  ArithmeticException - if the result exceeds the internal capacity

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

The following three lines are identical in effect:

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

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

The following three lines are identical in effect:

 LocalDateTime subtracted = dt.minusHours(6);
 LocalDateTime subtracted = dt.minus(Period.hours(6));
 LocalDateTime subtracted = dt.withFieldAdded(DurationFieldType.hours(), -6);
 

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

The following three lines are identical in effect:

 LocalDateTime subtracted = dt.minusMillis(6);
 LocalDateTime subtracted = dt.minus(Period.millis(6));
 LocalDateTime subtracted = dt.withFieldAdded(DurationFieldType.millis(), -6);
 

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

The following three lines are identical in effect:

 LocalDateTime subtracted = dt.minusMinutes(6);
 LocalDateTime subtracted = dt.minus(Period.minutes(6));
 LocalDateTime subtracted = dt.withFieldAdded(DurationFieldType.minutes(), -6);
 

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

The following three lines are identical in effect:

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

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

The following three lines are identical in effect:

 LocalDateTime subtracted = dt.minusSeconds(6);
 LocalDateTime subtracted = dt.minus(Period.seconds(6));
 LocalDateTime subtracted = dt.withFieldAdded(DurationFieldType.seconds(), -6);
 

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

The following three lines are identical in effect:

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

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

The following three lines are identical in effect:

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

If the amount is zero or null, then this is returned.
Parameters:
  duration - the duration to add to this one, null means zero a copy of this datetime with the duration added
throws:
  ArithmeticException - if the result exceeds the internal capacity

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 LocalDateTime.plusYears(int) .
Parameters:
  period - the period to add to this one, null means zero a copy of this datetime with the period added
throws:
  ArithmeticException - if the result exceeds the internal capacity

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

The following three lines are identical in effect:

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

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

The following three lines are identical in effect:

 LocalDateTime added = dt.plusHours(6);
 LocalDateTime added = dt.plus(Period.hours(6));
 LocalDateTime added = dt.withFieldAdded(DurationFieldType.hours(), 6);
 

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

The following three lines are identical in effect:

 LocalDateTime added = dt.plusMillis(6);
 LocalDateTime added = dt.plus(Period.millis(6));
 LocalDateTime added = dt.withFieldAdded(DurationFieldType.millis(), 6);
 

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

The following three lines are identical in effect:

 LocalDateTime added = dt.plusMinutes(6);
 LocalDateTime added = dt.plus(Period.minutes(6));
 LocalDateTime added = dt.withFieldAdded(DurationFieldType.minutes(), 6);
 

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

The following three lines are identical in effect:

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

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

The following three lines are identical in effect:

 LocalDateTime added = dt.plusSeconds(6);
 LocalDateTime added = dt.plus(Period.seconds(6));
 LocalDateTime added = dt.withFieldAdded(DurationFieldType.seconds(), 6);
 

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

The following three lines are identical in effect:

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

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

The following three lines are identical in effect:

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

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

This method will throw an exception if the datetime that would be created does not exist when the time zone is taken into account.
Parameters:
  zone - time zone to apply, or default if null a DateTime using the same millis

LocalDateTime 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

If the date is already the date passed in, then this is returned.

To set a single field use the properties, for example:

 DateTime set = dt.monthOfYear().setCopy(6);
 

LocalDateTime 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

LocalDateTime 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

LocalDateTime 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

If the addition is zero, then this is returned.
Parameters:
  durationToAdd - the duration 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 datetime with the duration added
throws:
  ArithmeticException - if the result exceeds the internal capacity

LocalDateTime 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 hourOfDay then the hour of day field would be changed in the returned instance. If the field type is null, then this is returned.

These three lines are equivalent:

 LocalDateTime updated = dt.withField(DateTimeFieldType.dayOfMonth(), 6);
 LocalDateTime updated = dt.dayOfMonth().setCopy(6);
 LocalDateTime updated = dt.property(DateTimeFieldType.dayOfMonth()).setCopy(6);
 

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

These three lines are equivalent:

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

For example, if the partial is a TimeOfDay then the time fields would be changed in the returned instance. If the partial is null, then this is returned.
Parameters:
  partial - the partial set of fields to apply to this datetime, null ignored a copy of this datetime with a different set of fields
throws:
  IllegalArgumentException - if any value is invalid

LocalDateTime is immutable, so there are no set methods. Instead, this method returns a new instance with the value of hour of day changed.
Parameters:
  hour - the hour of day to set a copy of this object with the field set
throws:
  IllegalArgumentException - if the 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 datetime with different millis

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

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

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

LocalDateTime 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 LocalDateTime.withFieldAdded(DurationFieldType,int) or LocalDateTime.plusYears(int) .
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 datetime with the period added
throws:
  ArithmeticException - if the result exceeds the internal capacity

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

If the time is already the time passed in, then this is returned.

To set a single field use the properties, for example:

 LocalDateTime set = dt.hourOfDay().setCopy(6);
 

LocalDateTime 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

LocalDateTime 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

LocalDateTime 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

LocalDateTime 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

LocalDateTime 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