org.joda.time
Interface ReadWritableInterval

All Superinterfaces:
ReadableInterval
All Known Implementing Classes:
MutableInterval

public interface ReadWritableInterval
extends ReadableInterval

Writable interface for an interval.

Since:
1.0
Author:
Stephen Colebourne, Brian S O'Neill

Method Summary
 void setChronology(Chronology chrono)
          Sets the chronology of this time interval.
 void setDurationAfterStart(ReadableDuration duration)
          Sets the duration of this time interval, preserving the start instant.
 void setDurationBeforeEnd(ReadableDuration duration)
          Sets the duration of this time interval, preserving the end instant.
 void setEnd(ReadableInstant instant)
          Sets the end of this time interval as an Instant.
 void setEndMillis(long millisInstant)
          Sets the end of this time interval.
 void setInterval(long startInstant, long endInstant)
          Sets this interval from two millisecond instants.
 void setInterval(ReadableInstant startInstant, ReadableInstant endInstant)
          Sets this interval from two instants.
 void setInterval(ReadableInterval interval)
          Sets this interval to be the same as another.
 void setPeriodAfterStart(ReadablePeriod period)
          Sets the period of this time interval, preserving the start instant.
 void setPeriodBeforeEnd(ReadablePeriod period)
          Sets the period of this time interval, preserving the end instant.
 void setStart(ReadableInstant instant)
          Sets the start of this time interval as an Instant.
 void setStartMillis(long millisInstant)
          Sets the start of this time interval.
 
Methods inherited from interface org.joda.time.ReadableInterval
contains, contains, equals, getChronology, getEnd, getEndMillis, getStart, getStartMillis, hashCode, isAfter, isAfter, isBefore, isBefore, overlaps, toDuration, toDurationMillis, toInterval, toMutableInterval, toPeriod, toPeriod, toString
 

Method Detail

setInterval

public void setInterval(long startInstant,
                        long endInstant)
Sets this interval from two millisecond instants.

Parameters:
startInstant - the start of the time interval
endInstant - the start of the time interval
Throws:
IllegalArgumentException - if the end is before the start

setInterval

public void setInterval(ReadableInterval interval)
Sets this interval to be the same as another.

Parameters:
interval - the interval to copy
Throws:
IllegalArgumentException - if the end is before the start

setInterval

public void setInterval(ReadableInstant startInstant,
                        ReadableInstant endInstant)
Sets this interval from two instants.

Parameters:
startInstant - the start of the time interval
endInstant - the start of the time interval
Throws:
IllegalArgumentException - if the end is before the start

setChronology

public void setChronology(Chronology chrono)
Sets the chronology of this time interval.

Parameters:
chrono - the chronology to use, null means ISO default

setStartMillis

public void setStartMillis(long millisInstant)
Sets the start of this time interval.

Parameters:
millisInstant - the start of the time interval, millisecond instant from 1970-01-01T00:00:00Z
Throws:
IllegalArgumentException - if the end is before the start

setStart

public void setStart(ReadableInstant instant)
Sets the start of this time interval as an Instant.

Parameters:
instant - the start of the time interval
Throws:
IllegalArgumentException - if the end is before the start

setEndMillis

public void setEndMillis(long millisInstant)
Sets the end of this time interval.

Parameters:
millisInstant - the end of the time interval, millisecond instant from 1970-01-01T00:00:00Z
Throws:
IllegalArgumentException - if the end is before the start

setEnd

public void setEnd(ReadableInstant instant)
Sets the end of this time interval as an Instant.

Parameters:
instant - the end of the time interval
Throws:
IllegalArgumentException - if the end is before the start

setDurationAfterStart

public void setDurationAfterStart(ReadableDuration duration)
Sets the duration of this time interval, preserving the start instant.

Parameters:
duration - new duration for interval
Throws:
IllegalArgumentException - if the end is before the start
ArithmeticException - if the end instant exceeds the capacity of a long

setDurationBeforeEnd

public void setDurationBeforeEnd(ReadableDuration duration)
Sets the duration of this time interval, preserving the end instant.

Parameters:
duration - new duration for interval
Throws:
IllegalArgumentException - if the end is before the start
ArithmeticException - if the start instant exceeds the capacity of a long

setPeriodAfterStart

public void setPeriodAfterStart(ReadablePeriod period)
Sets the period of this time interval, preserving the start instant.

Parameters:
period - new period for interval, null means zero length
Throws:
IllegalArgumentException - if the end is before the start
ArithmeticException - if the end instant exceeds the capacity of a long

setPeriodBeforeEnd

public void setPeriodBeforeEnd(ReadablePeriod period)
Sets the period of this time interval, preserving the end instant.

Parameters:
period - new period for interval, null means zero length
Throws:
IllegalArgumentException - if the end is before the start
ArithmeticException - if the start instant exceeds the capacity of a long


Copyright © 2002-2008 Joda.org. All Rights Reserved.