Interface ReadWritableInstant
- All Superinterfaces:
Comparable<ReadableInstant>,ReadableInstant
- All Known Subinterfaces:
ReadWritableDateTime
- All Known Implementing Classes:
MutableDateTime
The implementation of this interface will be mutable. It may provide more advanced methods than those in the interface.
- Since:
- 1.0
- Author:
- Stephen Colebourne
-
Method Summary
Modifier and TypeMethodDescriptionvoidadd(long duration) Adds a millisecond duration to this instant.voidadd(DurationFieldType type, int amount) Adds to the instant specifying the duration and multiple to add.voidadd(ReadableDuration duration) Adds a duration to this instant.voidadd(ReadableDuration duration, int scalar) Adds a duration to this instant specifying how many times to add.voidadd(ReadablePeriod period) Adds a period to this instant.voidadd(ReadablePeriod period, int scalar) Adds a period to this instant specifying how many times to add.voidset(DateTimeFieldType type, int value) Sets the value of one of the fields of the instant, such as hourOfDay.voidsetChronology(Chronology chronology) Sets the chronology of the datetime, which has no effect if not applicable.voidsetMillis(long instant) Sets the value as the number of milliseconds since the epoch, 1970-01-01T00:00:00Z.voidsetMillis(ReadableInstant instant) Sets the millisecond instant of this instant from another.voidsetZone(DateTimeZone zone) Sets the time zone of the datetime, changing the chronology and field values.voidSets the time zone of the datetime, changing the chronology and millisecond.Methods inherited from interface java.lang.Comparable
compareToMethods inherited from interface org.joda.time.ReadableInstant
equals, get, getChronology, getMillis, getZone, hashCode, isAfter, isBefore, isEqual, isSupported, toInstant, toString
-
Method Details
-
setMillis
void setMillis(long instant) Sets the value as the number of milliseconds since the epoch, 1970-01-01T00:00:00Z.- Parameters:
instant- the milliseconds since 1970-01-01T00:00:00Z to set the instant to- Throws:
IllegalArgumentException- if the value is invalid
-
setMillis
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
-
setChronology
Sets the chronology of the datetime, which has no effect if not applicable.- Parameters:
chronology- the chronology to use, null means ISOChronology in default zone- Throws:
IllegalArgumentException- if the value is invalid
-
setZone
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:
zone- the time zone to use, null means default zone- See Also:
-
setZoneRetainFields
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:
zone- the time zone to use, null means default zone- See Also:
-
add
void add(long duration) Adds a millisecond duration to this instant.This will typically change the value of ost fields.
- Parameters:
duration- the millis to add- Throws:
IllegalArgumentException- if the value is invalid
-
add
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
-
add
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 zeroscalar- direction and amount to add, which may be negative- Throws:
ArithmeticException- if the result exceeds the capacity of the instant
-
add
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
-
add
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 zeroscalar- direction and amount to add, which may be negative- Throws:
ArithmeticException- if the result exceeds the capacity of the instant
-
set
Sets the value of one of the fields of the instant, such as hourOfDay.- Parameters:
type- a field type, usually obtained from DateTimeFieldType, null ignoredvalue- the value to set the field to- Throws:
IllegalArgumentException- if the value is invalid
-
add
Adds to the instant specifying the duration and multiple to add.- Parameters:
type- a field type, usually obtained from DateTimeFieldType, null ignoredamount- the amount to add of this duration- Throws:
ArithmeticException- if the result exceeds the capacity of the instant
-