DateMidnight defines a date where the time component is fixed at midnight.
The class uses a time zone, thus midnight is local unless a UTC time zone is used.
It is important to emphasise that this class represents the time of midnight on
any given day.
Note that midnight is defined as 00:00, which is at the very start of a day.
This class does not represent a day, but the millisecond instant at midnight.
If you need a class that represents the whole day, then an
Interval
or
a
LocalDate
may be more suitable.
This class uses a Chronology internally. The Chronology 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 compatable with the modern Gregorian calendar.
Each individual field can be queried in two ways:
getDayOfMonth()
dayOfMonth().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
DateMidnight is thread-safe and immutable, provided that the Chronology is as well.
All standard Chronology classes supplied are thread-safe and immutable.
DateMidnight
public DateMidnight()
Constructs an instance set to the current system millisecond time
using ISOChronology
in the default time zone.
The constructed object will have a local time of midnight.
DateMidnight
public DateMidnight(Object instant)
Constructs an instance from an Object that represents a datetime.
The constructed object will have a local time of midnight.
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
DateMidnight
public DateMidnight(Object instant,
Chronology chronology)
Constructs an instance from an Object that represents a datetime,
using the specified chronology.
The constructed object will have a local time of midnight.
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 ISOChronology in default zone
DateMidnight
public DateMidnight(Object instant,
DateTimeZone zone)
Constructs an instance from an Object that represents a datetime,
forcing the time zone to that specified.
The constructed object will have a local time of midnight.
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
DateMidnight
public DateMidnight(int year,
int monthOfYear,
int dayOfMonth)
Constructs an instance from datetime field values
using ISOChronology
in the default time zone.
The constructed object will have a local time of midnight.
year
- the yearmonthOfYear
- the month of the yeardayOfMonth
- the day of the month
DateMidnight
public DateMidnight(int year,
int monthOfYear,
int dayOfMonth,
Chronology chronology)
Constructs an instance from datetime field values
using the specified chronology.
The constructed object will have a local time of midnight.
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 monthchronology
- the chronology, null means ISOChronology in default zone
DateMidnight
public DateMidnight(int year,
int monthOfYear,
int dayOfMonth,
DateTimeZone zone)
Constructs an instance from datetime field values
using
ISOChronology
in the specified time zone.
The constructed object will have a local time of midnight.
If the specified time zone is null, the default zone is used.
year
- the yearmonthOfYear
- the month of the yeardayOfMonth
- the day of the monthzone
- the time zone, null means default time zone
DateMidnight
public DateMidnight(long instant)
Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z
using ISOChronology
in the default time zone.
The constructed object will have a local time of midnight.
instant
- the milliseconds from 1970-01-01T00:00:00Z
DateMidnight
public DateMidnight(long instant,
Chronology chronology)
Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z
using the specified chronology.
The constructed object will have a local time of midnight.
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
DateMidnight
public DateMidnight(long instant,
DateTimeZone zone)
Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z
using
ISOChronology
in the specified time zone.
The constructed object will have a local time of midnight.
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
DateMidnight
public DateMidnight(Chronology chronology)
Constructs an instance set to the current system millisecond time
using the specified chronology.
The constructed object will have a local time of midnight.
If the chronology is null,
ISOChronology
in the default time zone is used.
chronology
- the chronology, null means ISOChronology in default zone
DateMidnight
public DateMidnight(DateTimeZone zone)
Constructs an instance set to the current system millisecond time
using
ISOChronology
in the specified time zone.
The constructed object will have a local time of midnight.
If the specified time zone is null, the default zone is used.
zone
- the time zone, null means default zone
centuryOfEra
public DateMidnight.Property centuryOfEra()
Get the century of era property which provides access to advanced functionality.
checkInstant
protected long checkInstant(long instant,
Chronology chronology)
Rounds the specified instant to midnight.
- checkInstant in interface BaseDateTime
instant
- the milliseconds from 1970-01-01T00:00:00Z to roundchronology
- the chronology to use, not null
- the updated instant, rounded to midnight
dayOfMonth
public DateMidnight.Property dayOfMonth()
Get the day of month property which provides access to advanced functionality.
- the day of month property
dayOfWeek
public DateMidnight.Property dayOfWeek()
Get the day of week property which provides access to advanced functionality.
dayOfYear
public DateMidnight.Property dayOfYear()
Get the day of year property which provides access to advanced functionality.
era
public DateMidnight.Property era()
Get the era property which provides access to advanced functionality.
minus
public DateMidnight minus(long duration)
Returns a copy of this date with the specified duration taken away.
If the amount is zero or null, then
this
is returned.
duration
- the duration, in millis, to reduce this instant by
- a copy of this datetime with the duration taken away
minus
public DateMidnight minus(ReadableDuration duration)
Returns a copy of this date with the specified duration taken away.
If the amount is zero or null, then
this
is returned.
duration
- the duration to reduce this instant by
- a copy of this datetime with the duration taken away
minus
public DateMidnight minus(ReadablePeriod period)
Returns a copy of this date with the specified period taken away.
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
minusYears(int)
.
period
- the period to reduce this instant by
- a copy of this datetime with the period taken away
minusDays
public DateMidnight minusDays(int days)
Returns a copy of this date minus the specified number of days.
This datetime instance is immutable and unaffected by this method call.
The following three lines are identical in effect:
DateMidnight subtracted = dt.minusDays(6);
DateMidnight subtracted = dt.minus(Period.days(6));
DateMidnight subtracted = dt.withFieldAdded(DurationFieldType.days(), -6);
days
- the amount of days to subtract, may be negative
- the new datetime minus the increased days
minusMonths
public DateMidnight minusMonths(int months)
Returns a copy of this date minus the specified number of months.
This datetime instance is immutable and unaffected by this method call.
The following three lines are identical in effect:
DateMidnight subtracted = dt.minusMonths(6);
DateMidnight subtracted = dt.minus(Period.months(6));
DateMidnight subtracted = dt.withFieldAdded(DurationFieldType.months(), -6);
months
- the amount of months to subtract, may be negative
- the new datetime minus the increased months
minusWeeks
public DateMidnight minusWeeks(int weeks)
Returns a copy of this date minus the specified number of weeks.
This datetime instance is immutable and unaffected by this method call.
The following three lines are identical in effect:
DateMidnight subtracted = dt.minusWeeks(6);
DateMidnight subtracted = dt.minus(Period.weeks(6));
DateMidnight subtracted = dt.withFieldAdded(DurationFieldType.weeks(), -6);
weeks
- the amount of weeks to subtract, may be negative
- the new datetime minus the increased weeks
minusYears
public DateMidnight minusYears(int years)
Returns a copy of this date minus the specified number of years.
This datetime instance is immutable and unaffected by this method call.
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);
years
- the amount of years to subtract, may be negative
- the new datetime minus the increased years
monthOfYear
public DateMidnight.Property monthOfYear()
Get the month of year property which provides access to advanced functionality.
- the month of year property
plus
public DateMidnight plus(long duration)
Returns a copy of this date with the specified duration added.
If the amount is zero, then
this
is returned.
duration
- the duration, in millis, to add to this one
- a copy of this datetime with the duration added
plus
public DateMidnight plus(ReadableDuration duration)
Returns a copy of this date with the specified duration added.
If the amount is zero or null, then
this
is returned.
duration
- the duration to add to this one, null means zero
- a copy of this datetime with the duration added
plus
public DateMidnight plus(ReadablePeriod period)
Returns a copy of this date with the specified period added.
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
plusYears(int)
.
period
- the duration to add to this one, null means zero
- a copy of this datetime with the period added
plusDays
public DateMidnight plusDays(int days)
Returns a copy of this date plus the specified number of days.
This datetime instance is immutable and unaffected by this method call.
The following three lines are identical in effect:
DateMidnight added = dt.plusDays(6);
DateMidnight added = dt.plus(Period.days(6));
DateMidnight added = dt.withFieldAdded(DurationFieldType.days(), 6);
days
- the amount of days to add, may be negative
- the new datetime plus the increased days
plusMonths
public DateMidnight plusMonths(int months)
Returns a copy of this date plus the specified number of months.
This datetime instance is immutable and unaffected by this method call.
The following three lines are identical in effect:
DateMidnight added = dt.plusMonths(6);
DateMidnight added = dt.plus(Period.months(6));
DateMidnight added = dt.withFieldAdded(DurationFieldType.months(), 6);
months
- the amount of months to add, may be negative
- the new datetime plus the increased months
plusWeeks
public DateMidnight plusWeeks(int weeks)
Returns a copy of this date plus the specified number of weeks.
This datetime instance is immutable and unaffected by this method call.
The following three lines are identical in effect:
DateMidnight added = dt.plusWeeks(6);
DateMidnight added = dt.plus(Period.weeks(6));
DateMidnight added = dt.withFieldAdded(DurationFieldType.weeks(), 6);
weeks
- the amount of weeks to add, may be negative
- the new datetime plus the increased weeks
plusYears
public DateMidnight plusYears(int years)
Returns a copy of this date plus the specified number of years.
This datetime instance is immutable and unaffected by this method call.
The following three lines are identical in effect:
DateMidnight added = dt.plusYears(6);
DateMidnight added = dt.plus(Period.years(6));
DateMidnight added = dt.withFieldAdded(DurationFieldType.years(), 6);
years
- the amount of years to add, may be negative
- the new datetime plus the increased years
property
public DateMidnight.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
toInterval
public Interval toInterval()
Converts this object to an
Interval
encompassing
the whole of this day.
The interval starts at midnight 00:00 and ends at 00:00 the following day,
(which is not included in the interval, as intervals are half-open).
toLocalDate
public LocalDate toLocalDate()
Converts this object to a LocalDate
with the
same date and chronology.
- a LocalDate with the same date and chronology
toYearMonthDay
public YearMonthDay toYearMonthDay()
Use LocalDate instead of YearMonthDay
Converts this object to a YearMonthDay
using the
same date and chronology.
- a YearMonthDay using the same millis and chronology
weekOfWeekyear
public DateMidnight.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 DateMidnight.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 DateMidnight withCenturyOfEra(int centuryOfEra)
Returns a copy of this date with the century of era field updated.
DateMidnight 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 DateMidnight withChronology(Chronology newChronology)
Returns a copy of this date with a different chronology, potentially
changing the day in unexpected ways.
This method creates a new DateMidnight using the midnight millisecond value
and the new chronology. If the same or similar chronology is specified, but
with a different time zone, the day may change. This occurs because the new
DateMidnight rounds down the millisecond value to get to midnight, and the
time zone change may result in a rounding down to a different day.
For example, changing time zone from London (+00:00) to Paris (+01:00) will
retain the same day, but changing from Paris to London will change the day.
(When its midnight in London its the same day in Paris, but when its midnight
in Paris its still the previous day in London)
To avoid these unusual effects, use
withZoneRetainFields(DateTimeZone)
to change time zones.
newChronology
- the new chronology
- a copy of this instant with a different chronology
withDayOfMonth
public DateMidnight withDayOfMonth(int dayOfMonth)
Returns a copy of this date with the day of month field updated.
DateMidnight 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 DateMidnight withDayOfWeek(int dayOfWeek)
Returns a copy of this date with the day of week field updated.
DateMidnight 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 DateMidnight withDayOfYear(int dayOfYear)
Returns a copy of this date with the day of year field updated.
DateMidnight 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 DateMidnight withDurationAdded(long durationToAdd,
int scalar)
Returns a copy of this date 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 DateMidnight withDurationAdded(ReadableDuration durationToAdd,
int scalar)
Returns a copy of this date 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 DateMidnight withEra(int era)
Returns a copy of this date with the era field updated.
DateMidnight 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 DateMidnight withField(DateTimeFieldType fieldType,
int value)
Returns a copy of this date with the specified field set to a new value.
For example, if the field type is
dayOfMonth
then the day of month
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 DateMidnight withFieldAdded(DurationFieldType fieldType,
int amount)
Returns a copy of this date 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:
DateMidnight added = dt.withFieldAdded(DateTimeFieldType.year(), 6);
DateMidnight added = dt.plusYears(6);
DateMidnight added = dt.year().addToCopy(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 DateMidnight withFields(ReadablePartial partial)
Returns a copy of this date with the partial set of fields replacing those
from this instance.
For example, if the partial is a
LocalDate
then the date 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
withMillis
public DateMidnight withMillis(long newMillis)
Returns a copy of this date with a different millisecond instant.
The returned object will have a local time of midnight.
Only the millis will change, the chronology and time zone are kept.
The returned object will be either be a new instance or
this
.
newMillis
- the new millis, from 1970-01-01T00:00:00Z
- a copy of this instant with different millis
withMonthOfYear
public DateMidnight withMonthOfYear(int monthOfYear)
Returns a copy of this date with the month of year field updated.
DateMidnight 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 DateMidnight withPeriodAdded(ReadablePeriod period,
int scalar)
Returns a copy of this date 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
withWeekOfWeekyear
public DateMidnight withWeekOfWeekyear(int weekOfWeekyear)
Returns a copy of this date with the week of weekyear field updated.
DateMidnight 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 DateMidnight withWeekyear(int weekyear)
Returns a copy of this date with the weekyear field updated.
DateMidnight 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 DateMidnight withYear(int year)
Returns a copy of this date with the year field updated.
DateMidnight 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 DateMidnight withYearOfCentury(int yearOfCentury)
Returns a copy of this date with the year of century field updated.
DateMidnight 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 DateMidnight withYearOfEra(int yearOfEra)
Returns a copy of this date with the year of era field updated.
DateMidnight 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
withZoneRetainFields
public DateMidnight withZoneRetainFields(DateTimeZone newZone)
Returns a copy of this date with a different time zone, preserving the day
The returned object will have a local time of midnight in the new zone on
the same day as the original instant.
newZone
- the new time zone, null means default
- a copy of this instant with a different time zone
year
public DateMidnight.Property year()
Get the year property which provides access to advanced functionality.
yearOfCentury
public DateMidnight.Property yearOfCentury()
Get the year of century property which provides access to advanced functionality.
yearOfEra
public DateMidnight.Property yearOfEra()
Get the year of era property which provides access to advanced functionality.