public class

MutableDateTime

extends BaseDateTime
implements Serializable Cloneable ReadWritableDateTime

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

Class Overview

MutableDateTime is the standard implementation of a modifiable datetime class. It holds the datetime as milliseconds from the Java epoch of 1970-01-01T00:00:00Z.

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 accessed in two ways:

getHourOfDay()
hourOfDay().get()

The second technique also provides access to other useful methods on the field:

get numeric value
set numeric value
add to numeric value
add to numeric value wrapping with the field
get text vlaue
get short text value
set text value
field maximum value
field minimum value

MutableDateTime is mutable and not thread-safe, unless concurrent threads are not invoking mutator methods.

Summary

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

Constants
int	ROUND_CEILING	Rounding mode as described by `roundCeiling(long)`
int	ROUND_FLOOR	Rounding mode as described by `roundFloor(long)`
int	ROUND_HALF_CEILING	Rounding mode as described by `roundHalfCeiling(long)`
int	ROUND_HALF_EVEN	Rounding mode as described by `roundHalfEven(long)`
int	ROUND_HALF_FLOOR	Rounding mode as described by `roundHalfFloor(long)`
int	ROUND_NONE	Rounding is disabled

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

Public Methods
void	add(ReadableDuration duration) Adds a duration to this instant.
void	add(long duration) Add an amount of time to the datetime.
void	add(ReadablePeriod period) Adds a period to this instant.
void	add(ReadablePeriod period, int scalar) Adds a period to this instant specifying how many times to add.
void	add(ReadableDuration duration, int scalar) Adds a duration to this instant specifying how many times to add.
void	add(DurationFieldType type, int amount) Adds to the instant specifying the duration and multiple to add.
void	addDays(int days) Add a number of days to the date.
void	addHours(int hours) Add a number of hours to the date.
void	addMillis(int millis) Add a number of milliseconds to the date.
void	addMinutes(int minutes) Add a number of minutes to the date.
void	addMonths(int months) Add a number of months to the date.
void	addSeconds(int seconds) Add a number of seconds to the date.
void	addWeeks(int weeks) Add a number of weeks to the date.
void	addWeekyears(int weekyears) Add a number of weekyears to the date.
void	addYears(int years) Add a number of years to the date.
MutableDateTime.Property	centuryOfEra() Get the century of era property.
Object	clone() Clone this object.
MutableDateTime	copy() Clone this object without having to cast the returned object.
MutableDateTime.Property	dayOfMonth() Get the day of month property.
MutableDateTime.Property	dayOfWeek() Get the day of week property.
MutableDateTime.Property	dayOfYear() Get the day of year property.
MutableDateTime.Property	era() Get the era property.
DateTimeField	getRoundingField() Gets the field used for rounding this instant, returning null if rounding is not enabled.
int	getRoundingMode() Gets the rounding mode for this instant, returning ROUND_NONE if rounding is not enabled.
MutableDateTime.Property	hourOfDay() Get the hour of day field property
MutableDateTime.Property	millisOfDay() Get the millis of day property
MutableDateTime.Property	millisOfSecond() Get the millis of second property
MutableDateTime.Property	minuteOfDay() Get the minute of day property
MutableDateTime.Property	minuteOfHour() Get the minute of hour field property
MutableDateTime.Property	monthOfYear() Get the month of year property.
MutableDateTime.Property	property(DateTimeFieldType type) Gets the property object for the specified type, which contains many useful methods.
MutableDateTime.Property	secondOfDay() Get the second of day property
MutableDateTime.Property	secondOfMinute() Get the second of minute field property
void	set(DateTimeFieldType type, int value) Sets the value of one of the fields of the instant, such as hourOfDay.
void	setChronology(Chronology chronology) Set the chronology of the datetime.
void	setDate(long instant) Set the date from milliseconds.
void	setDate(int year, int monthOfYear, int dayOfMonth) Set the date from fields.
void	setDate(ReadableInstant instant) Set the date from another instant.
void	setDateTime(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond) Set the date and time from fields.
void	setDayOfMonth(int dayOfMonth) Set the day of the month to the specified value.
void	setDayOfWeek(int dayOfWeek) Set the day of week to the specified value.
void	setDayOfYear(int dayOfYear) Set the day of year to the specified value.
void	setHourOfDay(int hourOfDay) Set the hour of the day to the specified value.
void	setMillis(ReadableInstant instant) Sets the millisecond instant of this instant from another.
void	setMillis(long instant) Set the milliseconds of the datetime.
void	setMillisOfDay(int millisOfDay) Set the millis of the day to the specified value.
void	setMillisOfSecond(int millisOfSecond) Set the millis of the second to the specified value.
void	setMinuteOfDay(int minuteOfDay) Set the minute of the day to the specified value.
void	setMinuteOfHour(int minuteOfHour) Set the minute of the hour to the specified value.
void	setMonthOfYear(int monthOfYear) Set the month of the year to the specified value.
void	setRounding(DateTimeField field) Sets the status of rounding to use the specified field and ROUND_FLOOR mode.
void	setRounding(DateTimeField field, int mode) Sets the status of rounding to use the specified field and mode.
void	setSecondOfDay(int secondOfDay) Set the second of the day to the specified value.
void	setSecondOfMinute(int secondOfMinute) Set the second of the minute to the specified value.
void	setTime(int hour, int minuteOfHour, int secondOfMinute, int millisOfSecond) Set the time from fields.
void	setTime(long millis) Set the time from milliseconds.
void	setTime(ReadableInstant instant) Set the time from another instant.
void	setWeekOfWeekyear(int weekOfWeekyear) Set the week of weekyear to the specified value.
void	setWeekyear(int weekyear) Set the weekyear to the specified value.
void	setYear(int year) Set the year to the specified value.
void	setZone(DateTimeZone newZone) Sets the time zone of the datetime, changing the chronology and field values.
void	setZoneRetainFields(DateTimeZone newZone) Sets the time zone of the datetime, changing the chronology and millisecond.
String	toString() Output the date time in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ).
MutableDateTime.Property	weekOfWeekyear() Get the week of a week based year property.
MutableDateTime.Property	weekyear() Get the year of a week based year property.
MutableDateTime.Property	year() Get the year property.
MutableDateTime.Property	yearOfCentury() Get the year of century property.
MutableDateTime.Property	yearOfEra() Get the year of era property.

[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.ReadWritableDateTime

abstract void	addDays(int days) Add a number of days to the date.
abstract void	addHours(int hours) Add a number of hours to the date.
abstract void	addMillis(int millis) Add a number of milliseconds to the date.
abstract void	addMinutes(int minutes) Add a number of minutes to the date.
abstract void	addMonths(int months) Add a number of months to the date.
abstract void	addSeconds(int seconds) Add a number of seconds to the date.
abstract void	addWeeks(int weeks) Add a number of weeks to the date.
abstract void	addWeekyears(int weekyears) Add a number of weekyears to the date.
abstract void	addYears(int years) Add a number of years to the date.
abstract void	setDate(int year, int monthOfYear, int dayOfMonth) Set the date from fields.
abstract void	setDateTime(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond) Set the date and time from fields.
abstract void	setDayOfMonth(int dayOfMonth) Set the day of the month to the specified value.
abstract void	setDayOfWeek(int dayOfWeek) Set the day of week to the specified value.
abstract void	setDayOfYear(int dayOfYear) Set the day of year to the specified value.
abstract void	setHourOfDay(int hourOfDay) Set the hour of the day to the specified value.
abstract void	setMillisOfDay(int millisOfDay) Set the millis of the day to the specified value.
abstract void	setMillisOfSecond(int millisOfSecond) Set the millis of the second to the specified value.
abstract void	setMinuteOfDay(int minuteOfDay) Set the minute of the day to the specified value.
abstract void	setMinuteOfHour(int minuteOfHour) Set the minute of the hour to the specified value.
abstract void	setMonthOfYear(int monthOfYear) Set the month of the year to the specified value.
abstract void	setSecondOfDay(int secondOfDay) Set the second of the day to the specified value.
abstract void	setSecondOfMinute(int secondOfMinute) Set the second of the minute to the specified value.
abstract void	setTime(int hour, int minuteOfHour, int secondOfMinute, int millisOfSecond) Set the time from fields.
abstract void	setWeekOfWeekyear(int weekOfWeekyear) Set the week of weekyear to the specified value.
abstract void	setWeekyear(int weekyear) Set the weekyear to the specified value.
abstract void	setYear(int year) Set the year to the specified value.

From interface org.joda.time.ReadWritableInstant

abstract void	add(ReadableDuration duration, int scalar) Adds a duration to this instant specifying how many times to add.
abstract void	add(long duration) Adds a millisecond duration to this instant.
abstract void	add(ReadablePeriod period) Adds a period to this instant.
abstract void	add(ReadableDuration duration) Adds a duration to this instant.
abstract void	add(ReadablePeriod period, int scalar) Adds a period to this instant specifying how many times to add.
abstract void	add(DurationFieldType type, int amount) Adds to the instant specifying the duration and multiple to add.
abstract void	set(DateTimeFieldType type, int value) Sets the value of one of the fields of the instant, such as hourOfDay.
abstract void	setChronology(Chronology chronology) Sets the chronology of the datetime, which has no effect if not applicable.
abstract void	setMillis(long instant) Sets the value as the number of milliseconds since the epoch, 1970-01-01T00:00:00Z.
abstract void	setMillis(ReadableInstant instant) Sets the millisecond instant of this instant from another.
abstract void	setZone(DateTimeZone zone) Sets the time zone of the datetime, changing the chronology and field values.
abstract void	setZoneRetainFields(DateTimeZone zone) Sets the time zone of the datetime, changing the chronology and millisecond.

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.

Constants

public static final int ROUND_CEILING

Rounding mode as described by roundCeiling(long)

Constant Value: 2 (0x00000002)

public static final int ROUND_FLOOR

Rounding mode as described by roundFloor(long)

Constant Value: 1 (0x00000001)

public static final int ROUND_HALF_CEILING

Rounding mode as described by roundHalfCeiling(long)

Constant Value: 4 (0x00000004)

public static final int ROUND_HALF_EVEN

Rounding mode as described by roundHalfEven(long)

Constant Value: 5 (0x00000005)

public static final int ROUND_HALF_FLOOR

Rounding mode as described by roundHalfFloor(long)

Constant Value: 3 (0x00000003)

public static final int ROUND_NONE

Rounding is disabled

Constant Value: 0 (0x00000000)

Public Constructors

public MutableDateTime ()

Constructs an instance set to the current system millisecond time using ISOChronology in the default time zone.

public MutableDateTime (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.

Parameters

zone	the time zone, null means default zone

public MutableDateTime (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.

Parameters

chronology	the chronology, null means ISOChronology in default zone

public MutableDateTime (long instant)

Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z using ISOChronology in the default time zone.

Parameters

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

public MutableDateTime (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.

Parameters

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

public MutableDateTime (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.

Parameters

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

public MutableDateTime (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.

Parameters

instant	the datetime object, null means now

Throws

IllegalArgumentException	if the instant is invalid

public MutableDateTime (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.

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 MutableDateTime (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.

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 MutableDateTime (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.

Parameters

year	the year
monthOfYear	the month of the year
dayOfMonth	the day of the month
hourOfDay	the hour of the day
minuteOfHour	the minute of the hour
secondOfMinute	the second of the minute
millisOfSecond	the millisecond of the second

public MutableDateTime (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.

Parameters

year	the year
monthOfYear	the month of the year
dayOfMonth	the day of the month
hourOfDay	the hour of the day
minuteOfHour	the minute of the hour
secondOfMinute	the second of the minute
millisOfSecond	the millisecond of the second
zone	the time zone, null means default time zone

public MutableDateTime (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.

Parameters

year	the year
monthOfYear	the month of the year
dayOfMonth	the day of the month
hourOfDay	the hour of the day
minuteOfHour	the minute of the hour
secondOfMinute	the second of the minute
millisOfSecond	the millisecond of the second
chronology	the chronology, null means ISOChronology in default zone

Public Methods

public void add (ReadableDuration duration)

Adds a duration to this instant.

This will typically change the value of most fields.

Parameters

duration	the duration to add, null means add zero

Throws

ArithmeticException	if the result exceeds the capacity of the instant

public void add (long duration)

Add an amount of time to the datetime.

Parameters

duration	the millis to add

Throws

ArithmeticException	if the result exceeds the capacity of the instant

public void add (ReadablePeriod period)

Adds a period to this instant.

This will typically change the value of most fields.

Parameters

period	the period to add, null means add zero

Throws

ArithmeticException	if the result exceeds the capacity of the instant

public void add (ReadablePeriod period, int scalar)

Adds a period to this instant specifying how many times to add.

This will typically change the value of most fields.

Parameters

period	the period to add, null means add zero
scalar	direction and amount to add, which may be negative

Throws

ArithmeticException	if the result exceeds the capacity of the instant

public void add (ReadableDuration duration, int scalar)

Adds a duration to this instant specifying how many times to add.

This will typically change the value of most fields.

Parameters

duration	the duration to add, null means add zero
scalar	direction and amount to add, which may be negative

Throws

ArithmeticException	if the result exceeds the capacity of the instant

public void add (DurationFieldType type, int amount)

Adds to the instant specifying the duration and multiple to add.

Parameters

type	a field type, usually obtained from DateTimeFieldType, not null
amount	the amount to add of this duration

Throws

IllegalArgumentException	if the value is null or invalid
ArithmeticException	if the result exceeds the capacity of the instant

public void addDays (int days)

Add a number of days to the date.

Parameters

days	the days to add

Throws

IllegalArgumentException	if the value is invalid

public void addHours (int hours)

Add a number of hours to the date.

Parameters

hours	the hours to add

Throws

IllegalArgumentException	if the value is invalid

public void addMillis (int millis)

Add a number of milliseconds to the date. The implementation of this method differs from the add(long) method in that a DateTimeField performs the addition.

Parameters

millis	the milliseconds to add

Throws

IllegalArgumentException	if the value is invalid

public void addMinutes (int minutes)

Add a number of minutes to the date.

Parameters

minutes	the minutes to add

Throws

IllegalArgumentException	if the value is invalid

public void addMonths (int months)

Add a number of months to the date.

Parameters

months	the months to add

Throws

IllegalArgumentException	if the value is invalid

public void addSeconds (int seconds)

Add a number of seconds to the date.

Parameters

seconds	the seconds to add

Throws

IllegalArgumentException	if the value is invalid

public void addWeeks (int weeks)

Add a number of weeks to the date.

Parameters

weeks	the weeks to add

Throws

IllegalArgumentException	if the value is invalid

public void addWeekyears (int weekyears)

Add a number of weekyears to the date.

Parameters

weekyears	the weekyears to add

Throws

IllegalArgumentException	if the value is invalid

public void addYears (int years)

Add a number of years to the date.

Parameters

years	the years to add

Throws

IllegalArgumentException	if the value is invalid

public MutableDateTime.Property centuryOfEra ()

Get the century of era property.

Returns

the year of era property

public Object clone ()

Clone this object.

Returns

a clone of this object.

public MutableDateTime copy ()

Clone this object without having to cast the returned object.

Returns

a clone of the this object.

public MutableDateTime.Property dayOfMonth ()

Get the day of month property.

The values for day of month are defined in DateTimeConstants.

Returns

the day of month property

public MutableDateTime.Property dayOfWeek ()

Get the day of week property.

The values for day of week are defined in DateTimeConstants.

Returns

the day of week property

public MutableDateTime.Property dayOfYear ()

Get the day of year property.

Returns

the day of year property

public MutableDateTime.Property era ()

Get the era property.

Returns

the era property

public DateTimeField getRoundingField ()

Gets the field used for rounding this instant, returning null if rounding is not enabled.

Returns

the rounding field

public int getRoundingMode ()

Gets the rounding mode for this instant, returning ROUND_NONE if rounding is not enabled.

Returns

the rounding mode constant

public MutableDateTime.Property hourOfDay ()

Get the hour of day field property

Returns

the hour of day property

public MutableDateTime.Property millisOfDay ()

Get the millis of day property

Returns

the millis of day property

public MutableDateTime.Property millisOfSecond ()

Get the millis of second property

Returns

the millis of second property

public MutableDateTime.Property minuteOfDay ()

Get the minute of day property

Returns

the minute of day property

public MutableDateTime.Property minuteOfHour ()

Get the minute of hour field property

Returns

the minute of hour property

public MutableDateTime.Property monthOfYear ()

Get the month of year property.

Returns

the month of year property

public MutableDateTime.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 MutableDateTime.Property secondOfDay ()

Get the second of day property

Returns

the second of day property

public MutableDateTime.Property secondOfMinute ()

Get the second of minute field property

Returns

the second of minute property

public void set (DateTimeFieldType type, int value)

Sets the value of one of the fields of the instant, such as hourOfDay.

Parameters

type	a field type, usually obtained from DateTimeFieldType, not null
value	the value to set the field to

Throws

IllegalArgumentException	if the value is null or invalid

public void setChronology (Chronology chronology)

Set the chronology of the datetime.

All changes to the chronology occur via this method.

Parameters

chronology	the chronology to use, null means ISOChronology in default zone

public void setDate (long instant)

Set the date from milliseconds. The time part of this object will be unaffected.

Parameters

instant	an instant to copy the date from, time part ignored

Throws

IllegalArgumentException	if the value is invalid

public void setDate (int year, int monthOfYear, int dayOfMonth)

Set the date from fields. The time part of this object will be unaffected.

Parameters

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

Throws

IllegalArgumentException	if the value is invalid

public void setDate (ReadableInstant instant)

Set the date from another instant. The time part of this object will be unaffected.

Parameters

instant	an instant to copy the date from, time part ignored

Throws

IllegalArgumentException	if the object is invalid

public void setDateTime (int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)

Set the date and time from fields.

Parameters

year	the year
monthOfYear	the month of the year
dayOfMonth	the day of the month
hourOfDay	the hour of the day
minuteOfHour	the minute of the hour
secondOfMinute	the second of the minute
millisOfSecond	the millisecond of the second

Throws

IllegalArgumentException	if the value is invalid

public void setDayOfMonth (int dayOfMonth)

Set the day of the month to the specified value.

Parameters

dayOfMonth	the day of the month

Throws

IllegalArgumentException	if the value is invalid

public void setDayOfWeek (int dayOfWeek)

Set the day of week to the specified value.

Parameters

dayOfWeek	the day of the week

Throws

IllegalArgumentException	if the value is invalid

public void setDayOfYear (int dayOfYear)

Set the day of year to the specified value.

Parameters

dayOfYear	the day of the year

Throws

IllegalArgumentException	if the value is invalid

public void setHourOfDay (int hourOfDay)

Set the hour of the day to the specified value.

Parameters

hourOfDay	the hour of day

Throws

IllegalArgumentException	if the value is invalid

public void setMillis (ReadableInstant instant)

Sets the millisecond instant of this instant from another.

This method does not change the chronology of this instant, just the millisecond instant.

Parameters

instant	the instant to use, null means now

public void setMillis (long instant)

Set the milliseconds of the datetime.

All changes to the millisecond field occurs via this method.

Parameters

instant	the milliseconds since 1970-01-01T00:00:00Z to set the datetime to

public void setMillisOfDay (int millisOfDay)

Set the millis of the day to the specified value.

Parameters

millisOfDay	the millis of day

Throws

IllegalArgumentException	if the value is invalid

public void setMillisOfSecond (int millisOfSecond)

Set the millis of the second to the specified value.

Parameters

millisOfSecond	the millis of second

Throws

IllegalArgumentException	if the value is invalid

public void setMinuteOfDay (int minuteOfDay)

Set the minute of the day to the specified value.

Parameters

minuteOfDay	the minute of day

Throws

IllegalArgumentException	if the value is invalid

public void setMinuteOfHour (int minuteOfHour)

Set the minute of the hour to the specified value.

Parameters

minuteOfHour	the minute of hour

Throws

IllegalArgumentException	if the value is invalid

public void setMonthOfYear (int monthOfYear)

Set the month of the year to the specified value.

Parameters

monthOfYear	the month of the year

Throws

IllegalArgumentException	if the value is invalid

public void setRounding (DateTimeField field)

Sets the status of rounding to use the specified field and ROUND_FLOOR mode. A null field will disable rounding. Once set, the instant is then rounded using the new field and mode.

Enabling rounding will cause all subsequent calls to setMillis(long) to be rounded. This can be used to control the precision of the instant, for example by setting a rounding field of minuteOfDay, the seconds and milliseconds will always be zero.

Parameters

field	rounding field or null to disable

public void setRounding (DateTimeField field, int mode)

Sets the status of rounding to use the specified field and mode. A null field or mode of ROUND_NONE will disable rounding. Once set, the instant is then rounded using the new field and mode.

Enabling rounding will cause all subsequent calls to setMillis(long) to be rounded. This can be used to control the precision of the instant, for example by setting a rounding field of minuteOfDay, the seconds and milliseconds will always be zero.

Parameters

field	rounding field or null to disable
mode	rounding mode or ROUND_NONE to disable

Throws

IllegalArgumentException	if mode is unknown, no exception if field is null

public void setSecondOfDay (int secondOfDay)

Set the second of the day to the specified value.

Parameters

secondOfDay	the second of day

Throws

IllegalArgumentException	if the value is invalid

public void setSecondOfMinute (int secondOfMinute)

Set the second of the minute to the specified value.

Parameters

secondOfMinute	the second of minute

Throws

IllegalArgumentException	if the value is invalid

public void setTime (int hour, int minuteOfHour, int secondOfMinute, int millisOfSecond)

Set the time from fields. The date part of this object will be unaffected.

Parameters

hour	the hour
minuteOfHour	the minute of the hour
secondOfMinute	the second of the minute
millisOfSecond	the millisecond of the second

Throws

IllegalArgumentException	if the value is invalid

public void setTime (long millis)

Set the time from milliseconds. The date part of this object will be unaffected.

Parameters

millis	an instant to copy the time from, date part ignored

Throws

IllegalArgumentException	if the value is invalid

public void setTime (ReadableInstant instant)

Set the time from another instant. The date part of this object will be unaffected.

Parameters

instant	an instant to copy the time from, date part ignored

Throws

IllegalArgumentException	if the object is invalid

public void setWeekOfWeekyear (int weekOfWeekyear)

Set the week of weekyear to the specified value.

Parameters

weekOfWeekyear	the week of the weekyear

Throws

IllegalArgumentException	if the value is invalid

public void setWeekyear (int weekyear)

Set the weekyear to the specified value.

Parameters

weekyear	the weekyear

Throws

IllegalArgumentException	if the value is invalid

public void setYear (int year)

Set the year to the specified value.

Parameters

year	the year

Throws

IllegalArgumentException	if the value is invalid

public void setZone (DateTimeZone newZone)

Sets the time zone of the datetime, changing the chronology and field values.

Changing the zone using this method retains the millisecond instant. The millisecond instant is adjusted in the new zone to compensate. chronology. Setting the time zone does not affect the millisecond value of this instant.

If the chronology already has this time zone, no change occurs.

Parameters

newZone	the time zone to use, null means default zone

public void setZoneRetainFields (DateTimeZone newZone)

Sets the time zone of the datetime, changing the chronology and millisecond.

Changing the zone using this method retains the field values. The millisecond instant is adjusted in the new zone to compensate.

If the chronology already has this time zone, no change occurs.

Parameters

newZone	the time zone to use, null means default zone

public String toString ()

Output the date time in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ).

Returns

ISO8601 time formatted string.

public MutableDateTime.Property weekOfWeekyear ()

Get the week of a week based year property.

Returns

the week of a week based year property

public MutableDateTime.Property weekyear ()

Get the year of a week based year property.

Returns

the year of a week based year property

public MutableDateTime.Property year ()

Get the year property.

Returns

the year property

public MutableDateTime.Property yearOfCentury ()

Get the year of century property.

Returns

the year of era property

public MutableDateTime.Property yearOfEra ()

Get the year of era property.

Returns

the year of era property

Interfaces

Classes

Exceptions

MutableDateTime

Class Overview

See Also

Summary

Constants

public static final int ROUND_CEILING

public static final int ROUND_FLOOR

public static final int ROUND_HALF_CEILING

public static final int ROUND_HALF_EVEN

public static final int ROUND_HALF_FLOOR

public static final int ROUND_NONE

Public Constructors

public MutableDateTime ()

public MutableDateTime (DateTimeZone zone)

Parameters

public MutableDateTime (Chronology chronology)

Parameters

public MutableDateTime (long instant)

Parameters

public MutableDateTime (long instant, DateTimeZone zone)

Parameters

public MutableDateTime (long instant, Chronology chronology)

Parameters

public MutableDateTime (Object instant)

Parameters

Throws

public MutableDateTime (Object instant, DateTimeZone zone)

Parameters

Throws

public MutableDateTime (Object instant, Chronology chronology)

Parameters

Throws

public MutableDateTime (int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)

Parameters

public MutableDateTime (int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond, DateTimeZone zone)

Parameters

public MutableDateTime (int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond, Chronology chronology)

Parameters

Public Methods

public void add (ReadableDuration duration)

Parameters

Throws

public void add (long duration)

Parameters

Throws

public void add (ReadablePeriod period)

Parameters

Throws

public void add (ReadablePeriod period, int scalar)

Parameters

Throws

public void add (ReadableDuration duration, int scalar)

Parameters

Throws

public void add (DurationFieldType type, int amount)

Parameters

Throws

public void addDays (int days)

Parameters

Throws

public void addHours (int hours)

Parameters

Throws

public void addMillis (int millis)

Parameters

Throws

public void addMinutes (int minutes)

Parameters

Throws

public void addMonths (int months)

Parameters

Throws

public void addSeconds (int seconds)

Parameters

Throws

public void addWeeks (int weeks)

Parameters