org.joda.time.base.BaseInterval Maven / Gradle / Ivy
/*
* Copyright 2001-2011 Stephen Colebourne
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.joda.time.base;
import java.io.Serializable;
import org.joda.time.Chronology;
import org.joda.time.DateTimeUtils;
import org.joda.time.MutableInterval;
import org.joda.time.ReadWritableInterval;
import org.joda.time.ReadableDuration;
import org.joda.time.ReadableInstant;
import org.joda.time.ReadableInterval;
import org.joda.time.ReadablePeriod;
import org.joda.time.chrono.ISOChronology;
import org.joda.time.convert.ConverterManager;
import org.joda.time.convert.IntervalConverter;
import org.joda.time.field.FieldUtils;
/**
* BaseInterval is an abstract implementation of ReadableInterval that stores
* data in two long millisecond fields.
*
* This class should generally not be used directly by API users.
* The {@link ReadableInterval} interface should be used when different
* kinds of interval objects are to be referenced.
*
* BaseInterval subclasses may be mutable and not thread-safe.
*
* @author Brian S O'Neill
* @author Sean Geoghegan
* @author Stephen Colebourne
* @since 1.0
*/
public abstract class BaseInterval
extends AbstractInterval
implements ReadableInterval, Serializable {
/** Serialization version */
private static final long serialVersionUID = 576586928732749278L;
/** The chronology of the interval */
private volatile Chronology iChronology;
/** The start of the interval */
private volatile long iStartMillis;
/** The end of the interval */
private volatile long iEndMillis;
/**
* Constructs an interval from a start and end instant.
*
* @param startInstant start of this interval, as milliseconds from 1970-01-01T00:00:00Z.
* @param endInstant end of this interval, as milliseconds from 1970-01-01T00:00:00Z.
* @param chrono the chronology to use, null is ISO default
* @throws IllegalArgumentException if the end is before the start
*/
protected BaseInterval(long startInstant, long endInstant, Chronology chrono) {
super();
iChronology = DateTimeUtils.getChronology(chrono);
checkInterval(startInstant, endInstant);
iStartMillis = startInstant;
iEndMillis = endInstant;
}
/**
* Constructs an interval from a start and end instant.
*
* @param start start of this interval, null means now
* @param end end of this interval, null means now
* @throws IllegalArgumentException if the end is before the start
*/
protected BaseInterval(ReadableInstant start, ReadableInstant end) {
super();
if (start == null && end == null) {
iStartMillis = iEndMillis = DateTimeUtils.currentTimeMillis();
iChronology = ISOChronology.getInstance();
} else {
iChronology = DateTimeUtils.getInstantChronology(start);
iStartMillis = DateTimeUtils.getInstantMillis(start);
iEndMillis = DateTimeUtils.getInstantMillis(end);
checkInterval(iStartMillis, iEndMillis);
}
}
/**
* Constructs an interval from a start instant and a duration.
*
* @param start start of this interval, null means now
* @param duration the duration of this interval, null means zero length
* @throws IllegalArgumentException if the end is before the start
* @throws ArithmeticException if the end instant exceeds the capacity of a long
*/
protected BaseInterval(ReadableInstant start, ReadableDuration duration) {
super();
iChronology = DateTimeUtils.getInstantChronology(start);
iStartMillis = DateTimeUtils.getInstantMillis(start);
long durationMillis = DateTimeUtils.getDurationMillis(duration);
iEndMillis = FieldUtils.safeAdd(iStartMillis, durationMillis);
checkInterval(iStartMillis, iEndMillis);
}
/**
* Constructs an interval from a millisecond duration and an end instant.
*
* @param duration the duration of this interval, null means zero length
* @param end end of this interval, null means now
* @throws IllegalArgumentException if the end is before the start
* @throws ArithmeticException if the start instant exceeds the capacity of a long
*/
protected BaseInterval(ReadableDuration duration, ReadableInstant end) {
super();
iChronology = DateTimeUtils.getInstantChronology(end);
iEndMillis = DateTimeUtils.getInstantMillis(end);
long durationMillis = DateTimeUtils.getDurationMillis(duration);
iStartMillis = FieldUtils.safeAdd(iEndMillis, -durationMillis);
checkInterval(iStartMillis, iEndMillis);
}
/**
* Constructs an interval from a start instant and a time period.
*
* When forming the interval, the chronology from the instant is used
* if present, otherwise the chronology of the period is used.
*
* @param start start of this interval, null means now
* @param period the period of this interval, null means zero length
* @throws IllegalArgumentException if the end is before the start
* @throws ArithmeticException if the end instant exceeds the capacity of a long
*/
protected BaseInterval(ReadableInstant start, ReadablePeriod period) {
super();
Chronology chrono = DateTimeUtils.getInstantChronology(start);
iChronology = chrono;
iStartMillis = DateTimeUtils.getInstantMillis(start);
if (period == null) {
iEndMillis = iStartMillis;
} else {
iEndMillis = chrono.add(period, iStartMillis, 1);
}
checkInterval(iStartMillis, iEndMillis);
}
/**
* Constructs an interval from a time period and an end instant.
*
* When forming the interval, the chronology from the instant is used
* if present, otherwise the chronology of the period is used.
*
* @param period the period of this interval, null means zero length
* @param end end of this interval, null means now
* @throws IllegalArgumentException if the end is before the start
* @throws ArithmeticException if the start instant exceeds the capacity of a long
*/
protected BaseInterval(ReadablePeriod period, ReadableInstant end) {
super();
Chronology chrono = DateTimeUtils.getInstantChronology(end);
iChronology = chrono;
iEndMillis = DateTimeUtils.getInstantMillis(end);
if (period == null) {
iStartMillis = iEndMillis;
} else {
iStartMillis = chrono.add(period, iEndMillis, -1);
}
checkInterval(iStartMillis, iEndMillis);
}
/**
* Constructs a time interval converting or copying from another object
* that describes an interval.
*
* @param interval the time interval to copy
* @param chrono the chronology to use, null means let converter decide
* @throws IllegalArgumentException if the interval is invalid
*/
protected BaseInterval(Object interval, Chronology chrono) {
super();
IntervalConverter converter = ConverterManager.getInstance().getIntervalConverter(interval);
if (converter.isReadableInterval(interval, chrono)) {
ReadableInterval input = (ReadableInterval) interval;
iChronology = (chrono != null ? chrono : input.getChronology());
iStartMillis = input.getStartMillis();
iEndMillis = input.getEndMillis();
} else if (this instanceof ReadWritableInterval) {
converter.setInto((ReadWritableInterval) this, interval, chrono);
} else {
MutableInterval mi = new MutableInterval();
converter.setInto(mi, interval, chrono);
iChronology = mi.getChronology();
iStartMillis = mi.getStartMillis();
iEndMillis = mi.getEndMillis();
}
checkInterval(iStartMillis, iEndMillis);
}
//-----------------------------------------------------------------------
/**
* Gets the chronology of this interval.
*
* @return the chronology
*/
public Chronology getChronology() {
return iChronology;
}
/**
* Gets the start of this time interval which is inclusive.
*
* @return the start of the time interval,
* millisecond instant from 1970-01-01T00:00:00Z
*/
public long getStartMillis() {
return iStartMillis;
}
/**
* Gets the end of this time interval which is exclusive.
*
* @return the end of the time interval,
* millisecond instant from 1970-01-01T00:00:00Z
*/
public long getEndMillis() {
return iEndMillis;
}
//-----------------------------------------------------------------------
/**
* Sets this interval from two millisecond instants and a chronology.
*
* @param startInstant the start of the time interval
* @param endInstant the start of the time interval
* @param chrono the chronology, not null
* @throws IllegalArgumentException if the end is before the start
*/
protected void setInterval(long startInstant, long endInstant, Chronology chrono) {
checkInterval(startInstant, endInstant);
iStartMillis = startInstant;
iEndMillis = endInstant;
iChronology = DateTimeUtils.getChronology(chrono);
}
}