DateTime is the standard implementation of an unmodifiable datetime class.
DateTime
is the most widely used implementation of
ReadableInstant
. As with all instants, it represents an exact
point on the time-line, but limited to the precision of milliseconds.
A
DateTime
calculates its fields with respect to a
time zone
.
Internally, the class holds two pieces of data. Firstly, it holds the
datetime as milliseconds from the Java epoch of 1970-01-01T00:00:00Z.
Secondly, it holds a
Chronology
which determines how the
millisecond instant value is converted into the date time fields.
The default Chronology is
ISOChronology
which is the agreed
international standard and compatible with the modern Gregorian calendar.
Each individual field can be queried in two ways:
getHourOfDay()
hourOfDay().get()
The second technique also provides access to other useful methods on the
field:
- numeric value
- text value
- short text value
- maximum/minimum values
- add/subtract
- set
- rounding
DateTime is thread-safe and immutable, provided that the Chronology is as well.
All standard Chronology classes supplied are thread-safe and immutable.
DateTime
public DateTime()
Constructs an instance set to the current system millisecond time
using ISOChronology
in the default time zone.
DateTime
public DateTime(Object instant)
Constructs an instance from an Object that represents a datetime.
If the object implies a chronology (such as GregorianCalendar does),
then that chronology will be used. Otherwise, ISO default is used.
Thus if a GregorianCalendar is passed in, the chronology used will
be GJ, but if a Date is passed in the chronology will be ISO.
The recognised object types are defined in
ConverterManager
and
include ReadableInstant, String, Calendar and Date.
The String formats are described by
ISODateTimeFormat.dateTimeParser()
.
instant
- the datetime object, null means now
DateTime
public DateTime(Object instant,
Chronology chronology)
Constructs an instance from an Object that represents a datetime,
using the specified chronology.
If the chronology is null, ISO in the default time zone is used.
Any chronology implied by the object (such as GregorianCalendar does)
is ignored.
The recognised object types are defined in
ConverterManager
and
include ReadableInstant, String, Calendar and Date.
The String formats are described by
ISODateTimeFormat.dateTimeParser()
.
instant
- the datetime object, null means nowchronology
- the chronology, null means ISO in default zone
DateTime
public DateTime(Object instant,
DateTimeZone zone)
Constructs an instance from an Object that represents a datetime,
forcing the time zone to that specified.
If the object implies a chronology (such as GregorianCalendar does),
then that chronology will be used, but with the time zone adjusted.
Otherwise, ISO is used in the specified time zone.
If the specified time zone is null, the default zone is used.
Thus if a GregorianCalendar is passed in, the chronology used will
be GJ, but if a Date is passed in the chronology will be ISO.
The recognised object types are defined in
ConverterManager
and
include ReadableInstant, String, Calendar and Date.
The String formats are described by
ISODateTimeFormat.dateTimeParser()
.
instant
- the datetime object, null means nowzone
- the time zone, null means default time zone
DateTime
public DateTime(int year,
int monthOfYear,
int dayOfMonth,
int hourOfDay,
int minuteOfHour,
int secondOfMinute,
int millisOfSecond)
Constructs an instance from datetime field values
using ISOChronology
in the default time zone.
year
- the yearmonthOfYear
- the month of the yeardayOfMonth
- the day of the monthhourOfDay
- the hour of the dayminuteOfHour
- the minute of the hoursecondOfMinute
- the second of the minutemillisOfSecond
- the millisecond of the second
DateTime
public DateTime(int year,
int monthOfYear,
int dayOfMonth,
int hourOfDay,
int minuteOfHour,
int secondOfMinute,
int millisOfSecond,
Chronology chronology)
Constructs an instance from datetime field values
using the specified chronology.
If the chronology is null,
ISOChronology
in the default time zone is used.
year
- the yearmonthOfYear
- the month of the yeardayOfMonth
- the day of the monthhourOfDay
- the hour of the dayminuteOfHour
- the minute of the hoursecondOfMinute
- the second of the minutemillisOfSecond
- the millisecond of the secondchronology
- the chronology, null means ISOChronology in default zone
DateTime
public DateTime(int year,
int monthOfYear,
int dayOfMonth,
int hourOfDay,
int minuteOfHour,
int secondOfMinute,
int millisOfSecond,
DateTimeZone zone)
Constructs an instance from datetime field values
using
ISOChronology
in the specified time zone.
If the specified time zone is null, the default zone is used.
year
- the yearmonthOfYear
- the month of the yeardayOfMonth
- the day of the monthhourOfDay
- the hour of the dayminuteOfHour
- the minute of the hoursecondOfMinute
- the second of the minutemillisOfSecond
- the millisecond of the secondzone
- the time zone, null means default time zone
DateTime
public DateTime(long instant)
Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z
using ISOChronology
in the default time zone.
instant
- the milliseconds from 1970-01-01T00:00:00Z
DateTime
public DateTime(long instant,
Chronology chronology)
Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z
using the specified chronology.
If the chronology is null,
ISOChronology
in the default time zone is used.
instant
- the milliseconds from 1970-01-01T00:00:00Zchronology
- the chronology, null means ISOChronology in default zone
DateTime
public DateTime(long instant,
DateTimeZone zone)
Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z
using
ISOChronology
in the specified time zone.
If the specified time zone is null, the default zone is used.
instant
- the milliseconds from 1970-01-01T00:00:00Zzone
- the time zone, null means default zone
DateTime
public DateTime(Chronology chronology)
Constructs an instance set to the current system millisecond time
using the specified chronology.
If the chronology is null,
ISOChronology
in the default time zone is used.
chronology
- the chronology, null means ISOChronology in default zone
DateTime
public DateTime(DateTimeZone zone)
Constructs an instance set to the current system millisecond time
using
ISOChronology
in the specified time zone.
If the specified time zone is null, the default zone is used.
zone
- the time zone, null means default zone
centuryOfEra
public DateTime.Property centuryOfEra()
Get the century of era property which provides access to advanced functionality.
dayOfMonth
public DateTime.Property dayOfMonth()
Get the day of month property which provides access to advanced functionality.
- the day of month property
dayOfWeek
public DateTime.Property dayOfWeek()
Get the day of week property which provides access to advanced functionality.
dayOfYear
public DateTime.Property dayOfYear()
Get the day of year property which provides access to advanced functionality.
era
public DateTime.Property era()
Get the era property which provides access to advanced functionality.
hourOfDay
public DateTime.Property hourOfDay()
Get the hour of day field property which provides access to advanced functionality.
millisOfDay
public DateTime.Property millisOfDay()
Get the millis of day property which provides access to advanced functionality.
- the millis of day property
millisOfSecond
public DateTime.Property millisOfSecond()
Get the millis of second property which provides access to advanced functionality.
- the millis of second property
minus
public DateTime minus(long duration)
Returns a copy of this datetime with the specified duration taken away.
If the amount is zero or null, then
this
is returned.
This datetime instance is immutable and unaffected by this method call.
duration
- the duration, in millis, to reduce this instant by
- a copy of this datetime with the duration taken away
minus
public DateTime minus(ReadableDuration duration)
Returns a copy of this datetime with the specified duration taken away.
If the amount is zero or null, then
this
is returned.
This datetime instance is immutable and unaffected by this method call.
duration
- the duration to reduce this instant by
- a copy of this datetime with the duration taken away
minus
public DateTime minus(ReadablePeriod period)
Returns a copy of this datetime with the specified period taken away.
This method will subtract each element of the period one by one, from
largest to smallest, adjusting the datetime to be accurate between each.
Thus, subtracting a period of one month and one day from 2007-05-31 will
work as follows:
First subtract one month and adjust, resulting in 2007-04-30
Then subtract one day and adjust, resulting in 2007-04-29.
Note that the day has been adjusted by two.
This method is typically used to subtract complex period instances.
Subtracting one field is best achieved using methods
like
minusYears(int)
.
If the amount is zero or null, then
this
is returned.
This datetime instance is immutable and unaffected by this method call.
period
- the period to reduce this instant by
- a copy of this datetime with the period taken away
minusDays
public DateTime minusDays(int days)
Returns a copy of this datetime minus the specified number of days.
The calculation will do its best to only change the day field
retaining the same time of day.
However, in certain circumstances, typically daylight savings cutover,
it may be necessary to alter the time fields.
In spring an hour is typically removed. If subtracting one day results
in the time being within the cutover then the time is adjusted to be
within summer time. For example, if the cutover is from 01:59 to 03:00
and the result of this method would have been 02:30, then the result
will be adjusted to 03:30.
The following three lines are identical in effect:
DateTime subtracted = dt.minusDays(6);
DateTime subtracted = dt.minus(Period.days(6));
DateTime subtracted = dt.withFieldAdded(DurationFieldType.days(), -6);
This datetime instance is immutable and unaffected by this method call.
days
- the amount of days to subtract, may be negative
- the new datetime minus the increased days
minusHours
public DateTime minusHours(int hours)
Returns a copy of this datetime minus the specified number of hours.
The calculation will subtract a duration equivalent to the number of
hours expressed in milliseconds.
For example, if a spring daylight savings cutover is from 01:59 to 03:00
then subtracting one hour from 03:30 will result in 01:30. This is a
duration of one hour earlier, even though the hour field value changed
from 3 to 1.
The following three lines are identical in effect:
DateTime subtracted = dt.minusHours(6);
DateTime subtracted = dt.minus(Period.hours(6));
DateTime subtracted = dt.withFieldAdded(DurationFieldType.hours(), -6);
This datetime instance is immutable and unaffected by this method call.
hours
- the amount of hours to subtract, may be negative
- the new datetime minus the increased hours
minusMillis
public DateTime minusMillis(int millis)
Returns a copy of this datetime minus the specified number of millis.
The calculation will subtract a duration equivalent to the number of
milliseconds.
The following three lines are identical in effect:
DateTime subtracted = dt.minusMillis(6);
DateTime subtracted = dt.minus(Period.millis(6));
DateTime subtracted = dt.withFieldAdded(DurationFieldType.millis(), -6);
This datetime instance is immutable and unaffected by this method call.
millis
- the amount of millis to subtract, may be negative
- the new datetime minus the increased millis
minusMinutes
public DateTime minusMinutes(int minutes)
Returns a copy of this datetime minus the specified number of minutes.
The calculation will subtract a duration equivalent to the number of
minutes expressed in milliseconds.
The following three lines are identical in effect:
DateTime subtracted = dt.minusMinutes(6);
DateTime subtracted = dt.minus(Period.minutes(6));
DateTime subtracted = dt.withFieldAdded(DurationFieldType.minutes(), -6);
This datetime instance is immutable and unaffected by this method call.
minutes
- the amount of minutes to subtract, may be negative
- the new datetime minus the increased minutes
minusMonths
public DateTime minusMonths(int months)
Returns a copy of this datetime minus the specified number of months.
The calculation will do its best to only change the month field
retaining the same day of month.
However, in certain circumstances, it may be necessary to alter
smaller fields. For example, 2007-05-31 minus one month cannot result
in 2007-04-31, so the day of month is adjusted to 2007-04-30.
The following three lines are identical in effect:
DateTime subtracted = dt.minusMonths(6);
DateTime subtracted = dt.minus(Period.months(6));
DateTime subtracted = dt.withFieldAdded(DurationFieldType.months(), -6);
This datetime instance is immutable and unaffected by this method call.
months
- the amount of months to subtract, may be negative
- the new datetime minus the increased months
minusSeconds
public DateTime minusSeconds(int seconds)
Returns a copy of this datetime minus the specified number of seconds.
The calculation will subtract a duration equivalent to the number of
seconds expressed in milliseconds.
The following three lines are identical in effect:
DateTime subtracted = dt.minusSeconds(6);
DateTime subtracted = dt.minus(Period.seconds(6));
DateTime subtracted = dt.withFieldAdded(DurationFieldType.seconds(), -6);
This datetime instance is immutable and unaffected by this method call.
seconds
- the amount of seconds to subtract, may be negative
- the new datetime minus the increased seconds
minusWeeks
public DateTime minusWeeks(int weeks)
Returns a copy of this datetime minus the specified number of weeks.
The calculation operates as if it were subtracting the equivalent in days.
The following three lines are identical in effect:
DateTime subtracted = dt.minusWeeks(6);
DateTime subtracted = dt.minus(Period.weeks(6));
DateTime subtracted = dt.withFieldAdded(DurationFieldType.weeks(), -6);
This datetime instance is immutable and unaffected by this method call.
weeks
- the amount of weeks to subtract, may be negative
- the new datetime minus the increased weeks
minusYears
public DateTime minusYears(int years)
Returns a copy of this datetime minus the specified number of years.
The calculation will do its best to only change the year field
retaining the same month of year.
However, in certain circumstances, it may be necessary to alter
smaller fields. For example, 2008-02-29 minus one year cannot result
in 2007-02-29, so the day of month is adjusted to 2007-02-28.
The following three lines are identical in effect:
DateTime subtracted = dt.minusYears(6);
DateTime subtracted = dt.minus(Period.years(6));
DateTime subtracted = dt.withFieldAdded(DurationFieldType.years(), -6);
This datetime instance is immutable and unaffected by this method call.
years
- the amount of years to subtract, may be negative
- the new datetime minus the increased years
minuteOfDay
public DateTime.Property minuteOfDay()
Get the minute of day property which provides access to advanced functionality.
- the minute of day property
minuteOfHour
public DateTime.Property minuteOfHour()
Get the minute of hour field property which provides access to advanced functionality.
- the minute of hour property
monthOfYear
public DateTime.Property monthOfYear()
Get the month of year property which provides access to advanced functionality.
- the month of year property
plus
public DateTime plus(long duration)
Returns a copy of this datetime with the specified duration added.
If the amount is zero or null, then
this
is returned.
This datetime instance is immutable and unaffected by this method call.
duration
- the duration, in millis, to add to this one
- a copy of this datetime with the duration added
plus
public DateTime plus(ReadableDuration duration)
Returns a copy of this datetime with the specified duration added.
If the amount is zero or null, then
this
is returned.
This datetime instance is immutable and unaffected by this method call.
duration
- the duration to add to this one, null means zero
- a copy of this datetime with the duration added
plus
public DateTime plus(ReadablePeriod period)
Returns a copy of this datetime with the specified period added.
This method will add each element of the period one by one, from largest
to smallest, adjusting the datetime to be accurate between each.
Thus, adding a period of one month and one day to 2007-03-31 will
work as follows:
First add one month and adjust, resulting in 2007-04-30
Then add one day and adjust, resulting in 2007-05-01.
This method is typically used to add complex period instances.
Adding one field is best achieved using methods
like
plusYears(int)
.
If the amount is zero or null, then
this
is returned.
This datetime instance is immutable and unaffected by this method call.
period
- the duration to add to this one, null means zero
- a copy of this datetime with the period added
plusDays
public DateTime plusDays(int days)
Returns a copy of this datetime plus the specified number of days.
The calculation will do its best to only change the day field
retaining the same time of day.
However, in certain circumstances, typically daylight savings cutover,
it may be necessary to alter the time fields.
In spring an hour is typically removed. If adding one day results in
the time being within the cutover then the time is adjusted to be
within summer time. For example, if the cutover is from 01:59 to 03:00
and the result of this method would have been 02:30, then the result
will be adjusted to 03:30.
The following three lines are identical in effect:
DateTime added = dt.plusDays(6);
DateTime added = dt.plus(Period.days(6));
DateTime added = dt.withFieldAdded(DurationFieldType.days(), 6);
This datetime instance is immutable and unaffected by this method call.
days
- the amount of days to add, may be negative
- the new datetime plus the increased days
plusHours
public DateTime plusHours(int hours)
Returns a copy of this datetime plus the specified number of hours.
The calculation will add a duration equivalent to the number of hours
expressed in milliseconds.
For example, if a spring daylight savings cutover is from 01:59 to 03:00
then adding one hour to 01:30 will result in 03:30. This is a duration
of one hour later, even though the hour field value changed from 1 to 3.
The following three lines are identical in effect:
DateTime added = dt.plusHours(6);
DateTime added = dt.plus(Period.hours(6));
DateTime added = dt.withFieldAdded(DurationFieldType.hours(), 6);
This datetime instance is immutable and unaffected by this method call.
hours
- the amount of hours to add, may be negative
- the new datetime plus the increased hours
plusMillis
public DateTime plusMillis(int millis)
Returns a copy of this datetime plus the specified number of millis.
The calculation will add a duration equivalent to the number of milliseconds.
The following three lines are identical in effect:
DateTime added = dt.plusMillis(6);
DateTime added = dt.plus(Period.millis(6));
DateTime added = dt.withFieldAdded(DurationFieldType.millis(), 6);
This datetime instance is immutable and unaffected by this method call.
millis
- the amount of millis to add, may be negative
- the new datetime plus the increased millis
plusMinutes
public DateTime plusMinutes(int minutes)
Returns a copy of this datetime plus the specified number of minutes.
The calculation will add a duration equivalent to the number of minutes
expressed in milliseconds.
The following three lines are identical in effect:
DateTime added = dt.plusMinutes(6);
DateTime added = dt.plus(Period.minutes(6));
DateTime added = dt.withFieldAdded(DurationFieldType.minutes(), 6);
This datetime instance is immutable and unaffected by this method call.
minutes
- the amount of minutes to add, may be negative
- the new datetime plus the increased minutes
plusMonths
public DateTime plusMonths(int months)
Returns a copy of this datetime plus the specified number of months.
The calculation will do its best to only change the month field
retaining the same day of month.
However, in certain circumstances, it may be necessary to alter
smaller fields. For example, 2007-03-31 plus one month cannot result
in 2007-04-31, so the day of month is adjusted to 2007-04-30.
The following three lines are identical in effect:
DateTime added = dt.plusMonths(6);
DateTime added = dt.plus(Period.months(6));
DateTime added = dt.withFieldAdded(DurationFieldType.months(), 6);
This datetime instance is immutable and unaffected by this method call.
months
- the amount of months to add, may be negative
- the new datetime plus the increased months
plusSeconds
public DateTime plusSeconds(int seconds)
Returns a copy of this datetime plus the specified number of seconds.
The calculation will add a duration equivalent to the number of seconds
expressed in milliseconds.
The following three lines are identical in effect:
DateTime added = dt.plusSeconds(6);
DateTime added = dt.plus(Period.seconds(6));
DateTime added = dt.withFieldAdded(DurationFieldType.seconds(), 6);
This datetime instance is immutable and unaffected by this method call.
seconds
- the amount of seconds to add, may be negative
- the new datetime plus the increased seconds
plusWeeks
public DateTime plusWeeks(int weeks)
Returns a copy of this datetime plus the specified number of weeks.
The calculation operates as if it were adding the equivalent in days.
The following three lines are identical in effect:
DateTime added = dt.plusWeeks(6);
DateTime added = dt.plus(Period.weeks(6));
DateTime added = dt.withFieldAdded(DurationFieldType.weeks(), 6);
This datetime instance is immutable and unaffected by this method call.
weeks
- the amount of weeks to add, may be negative
- the new datetime plus the increased weeks
plusYears
public DateTime plusYears(int years)
Returns a copy of this datetime plus the specified number of years.
The calculation will do its best to only change the year field
retaining the same month of year.
However, in certain circumstances, it may be necessary to alter
smaller fields. For example, 2008-02-29 plus one year cannot result
in 2009-02-29, so the day of month is adjusted to 2009-02-28.
The following three lines are identical in effect:
DateTime added = dt.plusYears(6);
DateTime added = dt.plus(Period.years(6));
DateTime added = dt.withFieldAdded(DurationFieldType.years(), 6);
This datetime instance is immutable and unaffected by this method call.
years
- the amount of years to add, may be negative
- the new datetime plus the increased years
property
public DateTime.Property property(DateTimeFieldType type)
Gets the property object for the specified type, which contains many useful methods.
type
- the field type to get the chronology for
secondOfDay
public DateTime.Property secondOfDay()
Get the second of day property which provides access to advanced functionality.
- the second of day property
secondOfMinute
public DateTime.Property secondOfMinute()
Get the second of minute field property which provides access to advanced functionality.
- the second of minute property
toDateMidnight
public DateMidnight toDateMidnight()
Converts this object to a DateMidnight
using the
same millis and chronology.
- a DateMidnight using the same millis and chronology
toDateTime
public DateTime toDateTime(Chronology chronology)
Get this object as a DateTime, returning this
if possible.
- toDateTime in interface AbstractInstant
chronology
- chronology to apply, or ISOChronology if null
- a DateTime using the same millis
toDateTime
public DateTime toDateTime(DateTimeZone zone)
Get this object as a DateTime, returning this
if possible.
- toDateTime in interface AbstractInstant
zone
- time zone to apply, or default if null
- a DateTime using the same millis
toDateTimeISO
public DateTime toDateTimeISO()
Get this object as a DateTime using ISOChronology in the default zone,
returning this
if possible.
- toDateTimeISO in interface AbstractInstant
- a DateTime using the same millis
toLocalDate
public LocalDate toLocalDate()
Converts this object to a LocalDate
with the
same date and chronology.
- a LocalDate with the same date and chronology
toLocalDateTime
public LocalDateTime toLocalDateTime()
Converts this object to a LocalDateTime
with
the same datetime and chronology.
- a LocalDateTime with the same datetime and chronology
toLocalTime
public LocalTime toLocalTime()
Converts this object to a LocalTime
with the
same time and chronology.
- a LocalTime with the same time and chronology
toTimeOfDay
public TimeOfDay toTimeOfDay()
Use LocalTime instead of TimeOfDay
Converts this object to a TimeOfDay
using the
same millis and chronology.
- a TimeOfDay using the same millis and chronology
toYearMonthDay
public YearMonthDay toYearMonthDay()
Use LocalDate instead of YearMonthDay
Converts this object to a YearMonthDay
using the
same millis and chronology.
- a YearMonthDay using the same millis and chronology
weekOfWeekyear
public DateTime.Property weekOfWeekyear()
Get the week of a week based year property which provides access to advanced functionality.
- the week of a week based year property
weekyear
public DateTime.Property weekyear()
Get the year of a week based year property which provides access to advanced functionality.
- the year of a week based year property
withCenturyOfEra
public DateTime withCenturyOfEra(int centuryOfEra)
Returns a copy of this datetime with the century of era field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
century of era changed.
centuryOfEra
- the centurey of era to set
- a copy of this object with the field set
withChronology
public DateTime withChronology(Chronology newChronology)
Returns a copy of this datetime with a different chronology.
The returned object will be either be a new instance or
this
.
Only the chronology will change, the millis are kept.
newChronology
- the new chronology, null means ISO default
- a copy of this datetime with a different chronology
withDate
public DateTime withDate(int year,
int monthOfYear,
int dayOfMonth)
Returns a copy of this datetime with the specified date, retaining the time fields.
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 = monthOfYear().setCopy(6);
year
- the new year valuemonthOfYear
- the new monthOfYear valuedayOfMonth
- the new dayOfMonth value
- a copy of this datetime with a different date
withDayOfMonth
public DateTime withDayOfMonth(int dayOfMonth)
Returns a copy of this datetime with the day of month field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
day of month changed.
dayOfMonth
- the day of month to set
- a copy of this object with the field set
withDayOfWeek
public DateTime withDayOfWeek(int dayOfWeek)
Returns a copy of this datetime with the day of week field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
day of week changed.
dayOfWeek
- the day of week to set
- a copy of this object with the field set
withDayOfYear
public DateTime withDayOfYear(int dayOfYear)
Returns a copy of this datetime with the day of year field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
day of year changed.
dayOfYear
- the day of year to set
- a copy of this object with the field set
withDurationAdded
public DateTime withDurationAdded(long durationToAdd,
int scalar)
Returns a copy of this datetime with the specified duration added.
If the addition is zero, then
this
is returned.
durationToAdd
- the duration to add to this onescalar
- the amount of times to add, such as -1 to subtract once
- a copy of this datetime with the duration added
withDurationAdded
public DateTime withDurationAdded(ReadableDuration durationToAdd,
int scalar)
Returns a copy of this datetime with the specified duration added.
If the addition is zero, then
this
is returned.
durationToAdd
- the duration to add to this one, null means zeroscalar
- the amount of times to add, such as -1 to subtract once
- a copy of this datetime with the duration added
withEra
public DateTime withEra(int era)
Returns a copy of this datetime with the era field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
era changed.
- a copy of this object with the field set
withField
public DateTime withField(DateTimeFieldType fieldType,
int value)
Returns a copy of this datetime with the specified field set to a new value.
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:
DateTime updated = dt.withField(DateTimeFieldType.dayOfMonth(), 6);
DateTime updated = dt.dayOfMonth().setCopy(6);
DateTime updated = dt.property(DateTimeFieldType.dayOfMonth()).setCopy(6);
fieldType
- the field type to set, not nullvalue
- the value to set
- a copy of this datetime with the field set
withFieldAdded
public DateTime withFieldAdded(DurationFieldType fieldType,
int amount)
Returns a copy of this datetime with the value of the specified field increased.
If the addition is zero or the field is null, then
this
is returned.
These three lines are equivalent:
DateTime added = dt.withFieldAdded(DurationFieldType.years(), 6);
DateTime added = dt.plusYears(6);
DateTime added = dt.plus(Period.years(6));
fieldType
- the field type to add to, not nullamount
- the amount to add
- a copy of this datetime with the field updated
withFields
public DateTime withFields(ReadablePartial partial)
Returns a copy of this datetime with the partial set of fields replacing those
from this instance.
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.
partial
- the partial set of fields to apply to this datetime, null ignored
- a copy of this datetime with a different set of fields
withHourOfDay
public DateTime withHourOfDay(int hour)
Returns a copy of this datetime with the hour of day field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
hour of day changed.
hour
- the hour of day to set
- a copy of this object with the field set
withMillis
public DateTime withMillis(long newMillis)
Returns a copy of this datetime with different millis.
The returned object will be either be a new instance or
this
.
Only the millis will change, the chronology and time zone are kept.
newMillis
- the new millis, from 1970-01-01T00:00:00Z
- a copy of this datetime with different millis
withMillisOfDay
public DateTime withMillisOfDay(int millis)
Returns a copy of this datetime with the millis of day field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
millis of day changed.
millis
- the millis of day to set
- a copy of this object with the field set
withMillisOfSecond
public DateTime withMillisOfSecond(int millis)
Returns a copy of this datetime with the millis of second field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
millis of second changed.
millis
- the millis of second to set
- a copy of this object with the field set
withMinuteOfHour
public DateTime withMinuteOfHour(int minute)
Returns a copy of this datetime with the minute of hour updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
minute of hour changed.
minute
- the minute of hour to set
- a copy of this object with the field set
withMonthOfYear
public DateTime withMonthOfYear(int monthOfYear)
Returns a copy of this datetime with the month of year field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
month of year changed.
monthOfYear
- the month of year to set
- a copy of this object with the field set
withPeriodAdded
public DateTime withPeriodAdded(ReadablePeriod period,
int scalar)
Returns a copy of this datetime with the specified period added.
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
withFieldAdded(DurationFieldType,int)
or
plusYears(int)
.
period
- the period to add to this one, null means zeroscalar
- the amount of times to add, such as -1 to subtract once
- a copy of this datetime with the period added
withSecondOfMinute
public DateTime withSecondOfMinute(int second)
Returns a copy of this datetime with the second of minute field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
second of minute changed.
second
- the second of minute to set
- a copy of this object with the field set
withTime
public DateTime withTime(int hourOfDay,
int minuteOfHour,
int secondOfMinute,
int millisOfSecond)
Returns a copy of this datetime with the specified time, retaining the date fields.
If the time is already the time passed in, then
this
is returned.
To set a single field use the properties, for example:
DateTime set = dt.hourOfDay().setCopy(6);
hourOfDay
- the hour of the dayminuteOfHour
- the minute of the hoursecondOfMinute
- the second of the minutemillisOfSecond
- the millisecond of the second
- a copy of this datetime with a different time
withWeekOfWeekyear
public DateTime withWeekOfWeekyear(int weekOfWeekyear)
Returns a copy of this datetime with the week of weekyear field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
week of weekyear changed.
weekOfWeekyear
- the week of weekyear to set
- a copy of this object with the field set
withWeekyear
public DateTime withWeekyear(int weekyear)
Returns a copy of this datetime with the weekyear field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
weekyear changed.
weekyear
- the weekyear to set
- a copy of this object with the field set
withYear
public DateTime withYear(int year)
Returns a copy of this datetime with the year field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
year changed.
- a copy of this object with the field set
withYearOfCentury
public DateTime withYearOfCentury(int yearOfCentury)
Returns a copy of this datetime with the year of century field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
year of century changed.
yearOfCentury
- the year of century to set
- a copy of this object with the field set
withYearOfEra
public DateTime withYearOfEra(int yearOfEra)
Returns a copy of this datetime with the year of era field updated.
DateTime is immutable, so there are no set methods.
Instead, this method returns a new instance with the value of
year of era changed.
yearOfEra
- the year of era to set
- a copy of this object with the field set
withZone
public DateTime withZone(DateTimeZone newZone)
Returns a copy of this datetime with a different time zone, preserving the
millisecond instant.
This method is useful for finding the local time in another timezone.
For example, if this instant holds 12:30 in Europe/London, the result
from this method with Europe/Paris would be 13:30.
The returned object will be a new instance of the same implementation type.
This method changes the time zone, and does not change the
millisecond instant, with the effect that the field values usually change.
The returned object will be either be a new instance or
this
.
newZone
- the new time zone
- a copy of this datetime with a different time zone
withZoneRetainFields
public DateTime withZoneRetainFields(DateTimeZone newZone)
Returns a copy of this datetime with a different time zone, preserving the
field values.
This method is useful for finding the millisecond time in another timezone.
For example, if this instant holds 12:30 in Europe/London (ie. 12:30Z),
the result from this method with Europe/Paris would be 12:30 (ie. 11:30Z).
The returned object will be a new instance of the same implementation type.
This method changes the time zone and the millisecond instant to keep
the field values the same.
The returned object will be either be a new instance or
this
.
newZone
- the new time zone, null means default
- a copy of this datetime with a different time zone
year
public DateTime.Property year()
Get the year property which provides access to advanced functionality.
yearOfCentury
public DateTime.Property yearOfCentury()
Get the year of century property which provides access to advanced functionality.
yearOfEra
public DateTime.Property yearOfEra()
Get the year of era property which provides access to advanced functionality.