| org.joda.time.ReadWritableInstant
| ReadWritableInstant | | public interface ReadWritableInstant extends ReadableInstant(Code) | | 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.
author:
Stephen Colebourne
since:
1.0 |
| Method Summary | |
| 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 | add(DurationFieldType type, int amount)
Adds to the instant specifying the duration and multiple 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.
Changing the zone using this method retains the millisecond instant.
The millisecond instant is adjusted in the new zone to compensate.
chronology. | | void | setZoneRetainFields(DateTimeZone zone)
Sets the time zone of the datetime, changing the chronology and millisecond. |
| add | | void add(long duration)(Code) | | 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 | | void add(ReadableDuration duration)(Code) | | 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 | | void add(ReadableDuration duration, int scalar)(Code) | | 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
Parameters:
scalar - direction and amount to add, which may be negative
throws:
ArithmeticException - if the result exceeds the capacity of the instant |
| add | | void add(ReadablePeriod period)(Code) | | 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 | | void add(ReadablePeriod period, int scalar)(Code) | | 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
Parameters:
scalar - direction and amount to add, which may be negative
throws:
ArithmeticException - if the result exceeds the capacity of the instant |
| add | | void add(DurationFieldType type, int amount)(Code) | | Adds to the instant specifying the duration and multiple to add.
Parameters:
type - a field type, usually obtained from DateTimeFieldType, null ignored
Parameters:
amount - the amount to add of this duration
throws:
ArithmeticException - if the result exceeds the capacity of the instant |
| set | | void set(DateTimeFieldType type, int value)(Code) | | Sets the value of one of the fields of the instant, such as hourOfDay.
Parameters:
type - a field type, usually obtained from DateTimeFieldType, null ignored
Parameters:
value - the value to set the field to
throws:
IllegalArgumentException - if the value is invalid |
| setChronology | | void setChronology(Chronology chronology)(Code) | | 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 |
| setMillis | | void setMillis(long instant)(Code) | | 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 theinstant to
throws:
IllegalArgumentException - if the value is invalid |
| setMillis | | void setMillis(ReadableInstant instant)(Code) | | 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 |
| setZone | | void setZone(DateTimeZone zone)(Code) | | 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: ReadWritableInstant.setZoneRetainFields |
| setZoneRetainFields | | void setZoneRetainFields(DateTimeZone zone)(Code) | | 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: ReadWritableInstant.setZone |
|
|