public final class

DateMidnight

extends BaseDateTime
implements Serializable ReadableDateTime

java.lang.Object
↳	org.joda.time.base.AbstractInstant
	↳	org.joda.time.base.AbstractDateTime
		↳	org.joda.time.base.BaseDateTime
			↳	org.joda.time.DateMidnight

Class Overview

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.

Summary

Nested Classes
class	DateMidnight.Property	DateMidnight.Property binds a DateMidnight to a DateTimeField allowing powerful datetime functionality to be easily accessed.

Public Constructors
	DateMidnight() Constructs an instance set to the current system millisecond time using `ISOChronology` in the default time zone.
	DateMidnight(DateTimeZone zone) Constructs an instance set to the current system millisecond time using `ISOChronology` in the specified time zone.
	DateMidnight(Chronology chronology) Constructs an instance set to the current system millisecond time using the specified chronology.
	DateMidnight(long instant) Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z using `ISOChronology` in the default time zone.
	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.
	DateMidnight(long instant, Chronology chronology) Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z using the specified chronology.
	DateMidnight(Object instant) Constructs an instance from an Object that represents a datetime.
	DateMidnight(Object instant, DateTimeZone zone) Constructs an instance from an Object that represents a datetime, forcing the time zone to that specified.
	DateMidnight(Object instant, Chronology chronology) Constructs an instance from an Object that represents a datetime, using the specified chronology.
	DateMidnight(int year, int monthOfYear, int dayOfMonth) Constructs an instance from datetime field values using `ISOChronology` in the default time zone.
	DateMidnight(int year, int monthOfYear, int dayOfMonth, DateTimeZone zone) Constructs an instance from datetime field values using `ISOChronology` in the specified time zone.
	DateMidnight(int year, int monthOfYear, int dayOfMonth, Chronology chronology) Constructs an instance from datetime field values using the specified chronology.

Public Methods
DateMidnight.Property	centuryOfEra() Get the century of era property which provides access to advanced functionality.
DateMidnight.Property	dayOfMonth() Get the day of month property which provides access to advanced functionality.
DateMidnight.Property	dayOfWeek() Get the day of week property which provides access to advanced functionality.
DateMidnight.Property	dayOfYear() Get the day of year property which provides access to advanced functionality.
DateMidnight.Property	era() Get the era property which provides access to advanced functionality.
DateMidnight	minus(ReadablePeriod period) Returns a copy of this date with the specified period taken away.
DateMidnight	minus(long duration) Returns a copy of this date with the specified duration taken away.
DateMidnight	minus(ReadableDuration duration) Returns a copy of this date with the specified duration taken away.
DateMidnight	minusDays(int days) Returns a copy of this date minus the specified number of days.
DateMidnight	minusMonths(int months) Returns a copy of this date minus the specified number of months.
DateMidnight	minusWeeks(int weeks) Returns a copy of this date minus the specified number of weeks.
DateMidnight	minusYears(int years) Returns a copy of this date minus the specified number of years.
DateMidnight.Property	monthOfYear() Get the month of year property which provides access to advanced functionality.
DateMidnight	plus(ReadablePeriod period) Returns a copy of this date with the specified period added.
DateMidnight	plus(long duration) Returns a copy of this date with the specified duration added.
DateMidnight	plus(ReadableDuration duration) Returns a copy of this date with the specified duration added.
DateMidnight	plusDays(int days) Returns a copy of this date plus the specified number of days.
DateMidnight	plusMonths(int months) Returns a copy of this date plus the specified number of months.
DateMidnight	plusWeeks(int weeks) Returns a copy of this date plus the specified number of weeks.
DateMidnight	plusYears(int years) Returns a copy of this date plus the specified number of years.
DateMidnight.Property	property(DateTimeFieldType type) Gets the property object for the specified type, which contains many useful methods.
Interval	toInterval() Converts this object to an `Interval` encompassing the whole of this day.
LocalDate	toLocalDate() Converts this object to a `LocalDate` with the same date and chronology.
YearMonthDay	toYearMonthDay() This method is deprecated. Use LocalDate instead of YearMonthDay
DateMidnight.Property	weekOfWeekyear() Get the week of a week based year property which provides access to advanced functionality.
DateMidnight.Property	weekyear() Get the year of a week based year property which provides access to advanced functionality.
DateMidnight	withCenturyOfEra(int centuryOfEra) Returns a copy of this date with the century of era field updated.
DateMidnight	withChronology(Chronology newChronology) Returns a copy of this date with a different chronology, potentially changing the day in unexpected ways.
DateMidnight	withDayOfMonth(int dayOfMonth) Returns a copy of this date with the day of month field updated.
DateMidnight	withDayOfWeek(int dayOfWeek) Returns a copy of this date with the day of week field updated.
DateMidnight	withDayOfYear(int dayOfYear) Returns a copy of this date with the day of year field updated.
DateMidnight	withDurationAdded(long durationToAdd, int scalar) Returns a copy of this date with the specified duration added.
DateMidnight	withDurationAdded(ReadableDuration durationToAdd, int scalar) Returns a copy of this date with the specified duration added.
DateMidnight	withEra(int era) Returns a copy of this date with the era field updated.
DateMidnight	withField(DateTimeFieldType fieldType, int value) Returns a copy of this date with the specified field set to a new value.
DateMidnight	withFieldAdded(DurationFieldType fieldType, int amount) Returns a copy of this date with the value of the specified field increased.
DateMidnight	withFields(ReadablePartial partial) Returns a copy of this date with the partial set of fields replacing those from this instance.
DateMidnight	withMillis(long newMillis) Returns a copy of this date with a different millisecond instant.
DateMidnight	withMonthOfYear(int monthOfYear) Returns a copy of this date with the month of year field updated.
DateMidnight	withPeriodAdded(ReadablePeriod period, int scalar) Returns a copy of this date with the specified period added.
DateMidnight	withWeekOfWeekyear(int weekOfWeekyear) Returns a copy of this date with the week of weekyear field updated.
DateMidnight	withWeekyear(int weekyear) Returns a copy of this date with the weekyear field updated.
DateMidnight	withYear(int year) Returns a copy of this date with the year field updated.
DateMidnight	withYearOfCentury(int yearOfCentury) Returns a copy of this date with the year of century field updated.
DateMidnight	withYearOfEra(int yearOfEra) Returns a copy of this date with the year of era field updated.
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.
DateMidnight.Property	year() Get the year property which provides access to advanced functionality.
DateMidnight.Property	yearOfCentury() Get the year of century property which provides access to advanced functionality.
DateMidnight.Property	yearOfEra() Get the year of era property which provides access to advanced functionality.

Protected Methods
long	checkInstant(long instant, Chronology chronology) Rounds the specified instant to midnight.

[Expand]

Inherited Methods

From class org.joda.time.base.BaseDateTime

From class org.joda.time.base.AbstractDateTime

int	get(DateTimeFieldType type) Get the value of one of the fields of a datetime.
int	getCenturyOfEra() Get the year of era field value.
int	getDayOfMonth() Get the day of month field value.
int	getDayOfWeek() Get the day of week field value.
int	getDayOfYear() Get the day of year field value.
int	getEra() Get the era field value.
int	getHourOfDay() Get the hour of day field value.
int	getMillisOfDay() Get the millis of day field value.
int	getMillisOfSecond() Get the millis of second field value.
int	getMinuteOfDay() Get the minute of day field value.
int	getMinuteOfHour() Get the minute of hour field value.
int	getMonthOfYear() Get the month of year field value.
int	getSecondOfDay() Get the second of day field value.
int	getSecondOfMinute() Get the second of minute field value.
int	getWeekOfWeekyear() Get the week of weekyear field value.
int	getWeekyear() Get the weekyear field value.
int	getYear() Get the year field value.
int	getYearOfCentury() Get the year of century field value.
int	getYearOfEra() Get the year of era field value.
Calendar	toCalendar(Locale locale) Get the date time as a `java.util.Calendar`, assigning exactly the same millisecond instant.
GregorianCalendar	toGregorianCalendar() Get the date time as a `java.util.GregorianCalendar`, assigning exactly the same millisecond instant.
String	toString(String pattern, Locale locale) Output the instant using the specified format pattern.
String	toString(String pattern) Output the instant using the specified format pattern.

From class org.joda.time.base.AbstractInstant

int	compareTo(Object instant) Compares this object with the specified object for ascending millisecond instant order.
boolean	equals(Object readableInstant) Compares this object with the specified object for equality based on the millisecond instant, chronology and time zone.
int	get(DateTimeFieldType type) Get the value of one of the fields of a datetime using the chronology of the instant.
int	get(DateTimeField field) Get the value of one of the fields of a datetime.
DateTimeZone	getZone() Gets the time zone of the instant from the chronology.
int	hashCode() Gets a hash code for the instant as defined in `ReadableInstant`.
boolean	isAfter(long instant) Is this instant after the millisecond instant passed in comparing solely by millisecond.
boolean	isAfter(ReadableInstant instant) Is this instant after the instant passed in comparing solely by millisecond.
boolean	isAfterNow() Is this instant after the current instant comparing solely by millisecond.
boolean	isBefore(long instant) Is this instant before the millisecond instant passed in comparing solely by millisecond.
boolean	isBefore(ReadableInstant instant) Is this instant before the instant passed in comparing solely by millisecond.
boolean	isBeforeNow() Is this instant before the current instant comparing solely by millisecond.
boolean	isEqual(ReadableInstant instant) Is this instant equal to the instant passed in comparing solely by millisecond.
boolean	isEqual(long instant) Is this instant equal to the millisecond instant passed in comparing solely by millisecond.
boolean	isEqualNow() Is this instant equal to the current instant comparing solely by millisecond.
boolean	isSupported(DateTimeFieldType type) Checks if the field type specified is supported by this instant and chronology.
Date	toDate() Get the date time as a `java.util.Date`.
DateTime	toDateTime(Chronology chronology) Get this object as a DateTime using the given chronology and its zone.
DateTime	toDateTime(DateTimeZone zone) Get this object as a DateTime using the same chronology but a different zone.
DateTime	toDateTime() Get this object as a DateTime in the same zone.
DateTime	toDateTimeISO() Get this object as a DateTime using ISOChronology in the same zone.
Instant	toInstant() Get this object as an Instant.
MutableDateTime	toMutableDateTime() Get this object as a MutableDateTime in the same zone.
MutableDateTime	toMutableDateTime(Chronology chronology) Get this object as a MutableDateTime using the given chronology and its zone.
MutableDateTime	toMutableDateTime(DateTimeZone zone) Get this object as a MutableDateTime using the same chronology but a different zone.
MutableDateTime	toMutableDateTimeISO() Get this object as a MutableDateTime using ISOChronology in the same zone.
String	toString() Output the date time in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ).
String	toString(DateTimeFormatter formatter) Uses the specified formatter to convert this partial to a String.

From class java.lang.Object

From interface java.lang.Comparable

From interface org.joda.time.ReadableDateTime

abstract int	getCenturyOfEra() Get the year of era field value.
abstract int	getDayOfMonth() Get the day of month field value.
abstract int	getDayOfWeek() Get the day of week field value.
abstract int	getDayOfYear() Get the day of year field value.
abstract int	getEra() Get the era field value.
abstract int	getHourOfDay() Get the hour of day field value.
abstract int	getMillisOfDay() Get the millis of day field value.
abstract int	getMillisOfSecond() Get the millis of second field value.
abstract int	getMinuteOfDay() Get the minute of day field value.
abstract int	getMinuteOfHour() Get the minute of hour field value.
abstract int	getMonthOfYear() Get the month of year field value.
abstract int	getSecondOfDay() Get the second of day field value.
abstract int	getSecondOfMinute() Get the second of minute field value.
abstract int	getWeekOfWeekyear() Get the week of weekyear field value.
abstract int	getWeekyear() Get the weekyear field value.
abstract int	getYear() Get the year field value.
abstract int	getYearOfCentury() Get the year of century field value.
abstract int	getYearOfEra() Get the year of era field value.
abstract DateTime	toDateTime() Get this object as a DateTime.
abstract MutableDateTime	toMutableDateTime() Get this object as a MutableDateTime, always returning a new instance.
abstract String	toString(String pattern, Locale locale) Output the instant using the specified format pattern.
abstract String	toString(String pattern) Output the instant using the specified format pattern.

From interface org.joda.time.ReadableInstant

abstract int	compareTo(Object readableInstant) Compares this object with the specified object for ascending millisecond instant order.
abstract boolean	equals(Object readableInstant) Compares this object with the specified object for equality based on the millisecond instant and the Chronology.
abstract int	get(DateTimeFieldType type) Get the value of one of the fields of a datetime.
abstract Chronology	getChronology() Gets the chronology of the instant.
abstract long	getMillis() Get the value as the number of milliseconds since the epoch, 1970-01-01T00:00:00Z.
abstract DateTimeZone	getZone() Gets the time zone of the instant from the chronology.
abstract int	hashCode() Gets a hash code for the instant that is compatible with the equals method.
abstract boolean	isAfter(ReadableInstant instant) Is this instant after the instant passed in comparing solely by millisecond.
abstract boolean	isBefore(ReadableInstant instant) Is this instant before the instant passed in comparing solely by millisecond.
abstract boolean	isEqual(ReadableInstant instant) Is this instant equal to the instant passed in comparing solely by millisecond.
abstract boolean	isSupported(DateTimeFieldType field) Checks whether the field type specified is supported by this implementation.
abstract Instant	toInstant() Get the value as a simple immutable `Instant` object.
abstract String	toString() Get the value as a String in a recognisable ISO8601 format.

Public Constructors

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.

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.

Parameters

zone	the time zone, null means default zone

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.

Parameters

chronology	the chronology, null means ISOChronology in default zone

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.

Parameters

instant	the milliseconds from 1970-01-01T00:00:00Z

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.

Parameters

instant	the milliseconds from 1970-01-01T00:00:00Z
zone	the time zone, null means default zone

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.

Parameters

instant	the milliseconds from 1970-01-01T00:00:00Z
chronology	the chronology, null means ISOChronology in default zone

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 dateTimeParser().

Parameters

instant	the datetime object, null means now

Throws

IllegalArgumentException	if the instant is invalid

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 dateTimeParser().

Parameters

instant	the datetime object, null means now
zone	the time zone, null means default time zone

Throws

IllegalArgumentException	if the instant is invalid

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 dateTimeParser().

Parameters

instant	the datetime object, null means now
chronology	the chronology, null means ISOChronology in default zone

Throws

IllegalArgumentException	if the instant is invalid

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.

Parameters

year	the year
monthOfYear	the month of the year
dayOfMonth	the day of the month

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.

Parameters

year	the year
monthOfYear	the month of the year
dayOfMonth	the day of the month
zone	the time zone, null means default time zone

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.

Parameters

year	the year
monthOfYear	the month of the year
dayOfMonth	the day of the month
chronology	the chronology, null means ISOChronology in default zone

Public Methods

public DateMidnight.Property centuryOfEra ()

Get the century of era property which provides access to advanced functionality.

Returns

the year of era property

public DateMidnight.Property dayOfMonth ()

Get the day of month property which provides access to advanced functionality.

Returns

the day of month property

public DateMidnight.Property dayOfWeek ()

Get the day of week property which provides access to advanced functionality.

Returns

the day of week property

public DateMidnight.Property dayOfYear ()

Get the day of year property which provides access to advanced functionality.

Returns

the day of year property

public DateMidnight.Property era ()

Get the era property which provides access to advanced functionality.

Returns

the era property

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

Parameters

period	the period to reduce this instant by

Returns

a copy of this datetime with the period taken away

Throws

ArithmeticException	if the new datetime exceeds the capacity of a long

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.

Parameters

duration	the duration, in millis, to reduce this instant by

Returns

a copy of this datetime with the duration taken away

Throws

ArithmeticException	if the new datetime exceeds the capacity of a long

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.

Parameters

duration	the duration to reduce this instant by

Returns

a copy of this datetime with the duration taken away

Throws

ArithmeticException	if the new datetime exceeds the capacity of a long

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);

Parameters

days	the amount of days to subtract, may be negative

Returns

the new datetime minus the increased days

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);

Parameters

months	the amount of months to subtract, may be negative

Returns

the new datetime minus the increased months

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);

Parameters

weeks	the amount of weeks to subtract, may be negative

Returns

the new datetime minus the increased weeks

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);

Parameters

years	the amount of years to subtract, may be negative

Returns

the new datetime minus the increased years

public DateMidnight.Property monthOfYear ()

Get the month of year property which provides access to advanced functionality.

Returns

the month of year property

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

Parameters

period	the duration to add to this one, null means zero

Returns

a copy of this datetime with the period added

Throws

ArithmeticException	if the new datetime exceeds the capacity of a long

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.

Parameters

duration	the duration, in millis, to add to this one

Returns

a copy of this datetime with the duration added

Throws

ArithmeticException	if the new datetime exceeds the capacity of a long

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.

Parameters

duration	the duration to add to this one, null means zero

Returns

a copy of this datetime with the duration added

Throws

ArithmeticException	if the new datetime exceeds the capacity of a long

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);

Parameters

days	the amount of days to add, may be negative

Returns

the new datetime plus the increased days

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);

Parameters

months	the amount of months to add, may be negative

Returns

the new datetime plus the increased months

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);

Parameters

weeks	the amount of weeks to add, may be negative

Returns

the new datetime plus the increased weeks

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);

Parameters

years	the amount of years to add, may be negative

Returns

the new datetime plus the increased years

public DateMidnight.Property property (DateTimeFieldType type)

Gets the property object for the specified type, which contains many useful methods.

Parameters

type	the field type to get the chronology for

Returns

the property object

Throws

IllegalArgumentException	if the field is null or unsupported

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

Returns

an interval over the day

public LocalDate toLocalDate ()

Converts this object to a LocalDate with the same date and chronology.

Returns

a LocalDate with the same date and chronology

public YearMonthDay toYearMonthDay ()

This method is deprecated.
Use LocalDate instead of YearMonthDay

Converts this object to a YearMonthDay using the same date and chronology.

Returns

a YearMonthDay using the same millis and chronology

public DateMidnight.Property weekOfWeekyear ()

Get the week of a week based year property which provides access to advanced functionality.

Returns

the week of a week based year property

public DateMidnight.Property weekyear ()

Get the year of a week based year property which provides access to advanced functionality.

Returns

the year of a week based year property

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.

Parameters

centuryOfEra	the centurey of era to set

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

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.

Parameters

newChronology	the new chronology

Returns

a copy of this instant with a different chronology

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.

Parameters

dayOfMonth	the day of month to set

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

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.

Parameters

dayOfWeek	the day of week to set

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

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.

Parameters

dayOfYear	the day of year to set

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

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.

Parameters

durationToAdd	the duration to add to this one
scalar	the amount of times to add, such as -1 to subtract once

Returns

a copy of this datetime with the duration added

Throws

ArithmeticException	if the new datetime exceeds the capacity of a long

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.

Parameters

durationToAdd	the duration to add to this one, null means zero
scalar	the amount of times to add, such as -1 to subtract once

Returns

a copy of this datetime with the duration added

Throws

ArithmeticException	if the new datetime exceeds the capacity of a long

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.

Parameters

era	the era to set

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

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);

Parameters

fieldType	the field type to set, not null
value	the value to set

Returns

a copy of this datetime with the field set

Throws

IllegalArgumentException	if the value is null or invalid

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);

Parameters

fieldType	the field type to add to, not null
amount	the amount to add

Returns

a copy of this datetime with the field updated

Throws

IllegalArgumentException	if the value is null or invalid
ArithmeticException	if the new datetime exceeds the capacity of a long

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.

Parameters

partial	the partial set of fields to apply to this datetime, null ignored

Returns

a copy of this datetime with a different set of fields

Throws

IllegalArgumentException	if any value is invalid

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.

Parameters

newMillis	the new millis, from 1970-01-01T00:00:00Z

Returns

a copy of this instant with different millis

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.

Parameters

monthOfYear	the month of year to set

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

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

Parameters

period	the period to add to this one, null means zero
scalar	the amount of times to add, such as -1 to subtract once

Returns

a copy of this datetime with the period added

Throws

ArithmeticException	if the new datetime exceeds the capacity of a long

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.

Parameters

weekOfWeekyear	the week of weekyear to set

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

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.

Parameters

weekyear	the weekyear to set

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

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.

Parameters

year	the year to set

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

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.

Parameters

yearOfCentury	the year of century to set

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

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.

Parameters

yearOfEra	the year of era to set

Returns

a copy of this object with the field set

Throws

IllegalArgumentException	if the value is invalid

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.

Parameters

newZone	the new time zone, null means default

Returns

a copy of this instant with a different time zone

public DateMidnight.Property year ()

Get the year property which provides access to advanced functionality.

Returns

the year property

public DateMidnight.Property yearOfCentury ()

Get the year of century property which provides access to advanced functionality.

Returns

the year of era property

public DateMidnight.Property yearOfEra ()

Get the year of era property which provides access to advanced functionality.

Returns

the year of era property

Protected Methods

protected long checkInstant (long instant, Chronology chronology)

Rounds the specified instant to midnight.

Parameters

instant	the milliseconds from 1970-01-01T00:00:00Z to round
chronology	the chronology to use, not null

Returns

the updated instant, rounded to midnight

Interfaces

Classes

Exceptions

DateMidnight

Class Overview

Summary

Public Constructors

public DateMidnight ()

public DateMidnight (DateTimeZone zone)

Parameters

public DateMidnight (Chronology chronology)

Parameters

public DateMidnight (long instant)

Parameters

public DateMidnight (long instant, DateTimeZone zone)

Parameters

public DateMidnight (long instant, Chronology chronology)

Parameters

public DateMidnight (Object instant)

Parameters

Throws

public DateMidnight (Object instant, DateTimeZone zone)

Parameters

Throws

public DateMidnight (Object instant, Chronology chronology)

Parameters

Throws

public DateMidnight (int year, int monthOfYear, int dayOfMonth)

Parameters

public DateMidnight (int year, int monthOfYear, int dayOfMonth, DateTimeZone zone)

Parameters

public DateMidnight (int year, int monthOfYear, int dayOfMonth, Chronology chronology)

Parameters

Public Methods

public DateMidnight.Property centuryOfEra ()

Returns

public DateMidnight.Property dayOfMonth ()

Returns

public DateMidnight.Property dayOfWeek ()

Returns

public DateMidnight.Property dayOfYear ()

Returns

public DateMidnight.Property era ()

Returns

public DateMidnight minus (ReadablePeriod period)

Parameters

Returns

Throws

public DateMidnight minus (long duration)

Parameters

Returns

Throws

public DateMidnight minus (ReadableDuration duration)

Parameters

Returns

Throws

public DateMidnight minusDays (int days)

Parameters

Returns

public DateMidnight minusMonths (int months)

Parameters

Returns

public DateMidnight minusWeeks (int weeks)

Parameters

Returns

public DateMidnight minusYears (int years)

Parameters

Returns

public DateMidnight.Property monthOfYear ()

Returns

public DateMidnight plus (ReadablePeriod period)

Parameters

Returns

Throws

public DateMidnight plus (long duration)

Parameters

Returns

Throws

public DateMidnight plus (ReadableDuration duration)

Parameters