|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ReadWritableInstant
Defines an instant in the datetime continuum that can be queried and modified. This interface expresses the datetime as milliseconds from 1970-01-01T00:00:00Z.
The implementation of this interface will be mutable. It may provide more advanced methods than those in the interface.
Method Summary | |
---|---|
void |
add(DurationFieldType type,
int amount)
Adds to the instant specifying the duration and multiple to add. |
void |
add(long duration)
Adds a millisecond duration to this instant. |
void |
add(ReadableDuration duration)
Adds a duration to this instant. |
void |
add(ReadableDuration duration,
int scalar)
Adds a duration to this instant specifying how many times to add. |
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 |
set(DateTimeFieldType type,
int value)
Sets the value of one of the fields of the instant, such as hourOfDay. |
void |
setChronology(Chronology chronology)
Sets the chronology of the datetime, which has no effect if not applicable. |
void |
setMillis(long instant)
Sets the value as the number of milliseconds since the epoch, 1970-01-01T00:00:00Z. |
void |
setMillis(ReadableInstant instant)
Sets the millisecond instant of this instant from another. |
void |
setZone(DateTimeZone zone)
Sets the time zone of the datetime, changing the chronology and field values. |
void |
setZoneRetainFields(DateTimeZone zone)
Sets the time zone of the datetime, changing the chronology and millisecond. |
Methods inherited from interface org.joda.time.ReadableInstant |
---|
equals, get, getChronology, getMillis, getZone, hashCode, isAfter, isBefore, isEqual, isSupported, toInstant, toString |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Method Detail |
---|
void setMillis(long instant)
instant
- the milliseconds since 1970-01-01T00:00:00Z to set the
instant to
IllegalArgumentException
- if the value is invalidvoid setMillis(ReadableInstant instant)
This method does not change the chronology of this instant, just the millisecond instant.
instant
- the instant to use, null means nowvoid setChronology(Chronology chronology)
chronology
- the chronology to use, null means ISOChronology in default zone
IllegalArgumentException
- if the value is invalidvoid setZone(DateTimeZone zone)
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.
zone
- the time zone to use, null means default zonesetZoneRetainFields(org.joda.time.DateTimeZone)
void setZoneRetainFields(DateTimeZone zone)
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.
zone
- the time zone to use, null means default zonesetZone(org.joda.time.DateTimeZone)
void add(long duration)
This will typically change the value of ost fields.
duration
- the millis to add
IllegalArgumentException
- if the value is invalidvoid add(ReadableDuration duration)
This will typically change the value of most fields.
duration
- the duration to add, null means add zero
ArithmeticException
- if the result exceeds the capacity of the instantvoid add(ReadableDuration duration, int scalar)
This will typically change the value of most fields.
duration
- the duration to add, null means add zeroscalar
- direction and amount to add, which may be negative
ArithmeticException
- if the result exceeds the capacity of the instantvoid add(ReadablePeriod period)
This will typically change the value of most fields.
period
- the period to add, null means add zero
ArithmeticException
- if the result exceeds the capacity of the instantvoid add(ReadablePeriod period, int scalar)
This will typically change the value of most fields.
period
- the period to add, null means add zeroscalar
- direction and amount to add, which may be negative
ArithmeticException
- if the result exceeds the capacity of the instantvoid set(DateTimeFieldType type, int value)
type
- a field type, usually obtained from DateTimeFieldType, null ignoredvalue
- the value to set the field to
IllegalArgumentException
- if the value is invalidvoid add(DurationFieldType type, int amount)
type
- a field type, usually obtained from DateTimeFieldType, null ignoredamount
- the amount to add of this duration
ArithmeticException
- if the result exceeds the capacity of the instant
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |