org.jdesktop.swingx.calendar.DateSpan Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of swingx-all Show documentation
Show all versions of swingx-all Show documentation
Fork of the inactive swingx-all library
/*
* $Id: DateSpan.java 542 2005-10-10 18:03:15Z rbair $
*
* Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
* Santa Clara, California 95054, U.S.A. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.jdesktop.swingx.calendar;
import java.util.Date;
/**
* An immutable representation of a time range. The time range is
* internally represented as two longs. The methods that take and return
* Dates create the Dates as needed, so that
* if you modify returned Dates you will not effect
* the DateSpan. The end points are inclusive.
*
* @version $Revision: 542 $
*/
public class DateSpan {
private final long start;
private final long end;
/**
* Creates a DateSpan between the two end points.
*
* @param start Beginning date
* @param end Ending date
* @throws IllegalArgumentException if start is after
* end
*/
public DateSpan(long start, long end) {
this.start = start;
this.end = end;
if (this.start > this.end) {
throw new IllegalArgumentException("Start date must be before end date");
}
}
/**
* Creates a DateSpan between the two end points. This
* is a conveniance constructor that is equivalent to
* new Date(start.getTime(), end.getTime());.
*
* @param start Beginning date
* @param end Ending date
*/
public DateSpan(Date start, Date end) {
this(start.getTime(), end.getTime());
}
/**
* Returns the start of the date span.
*
* @return start of the span.
*/
public long getStart() {
return start;
}
/**
* Returns the end of the date span.
*
* @return end of the span.
*/
public long getEnd() {
return end;
}
/**
* Returns the start of the date span as a Date.
*
* @return start of the span.
*/
public Date getStartAsDate() {
return new Date(getStart());
}
/**
* Returns the end of the date span as a Date.
*
* @return end of the span.
*/
public Date getEndAsDate() {
return new Date(getEnd());
}
/**
* Returns true if this DateSpan contains the specified
* DateSpan.
*
* @param span Date to check
* @return true if this DateSpan contains span.
*/
public boolean contains(DateSpan span) {
return contains(span.getStart()) && contains(span.getEnd());
}
/**
* Returns whether or not this DateSpan contains the specified
* time.
*
* @param time time check
* @return true if this DateSpan contains time.
*/
public boolean contains(long time) {
return time >= getStart() && time <= getEnd();
}
/**
* Returns whether or not this DateSpan contains the
* specified date span.
*
* @param start Start of time span
* @param end End of time
* @return true if this DateSpan contains the specified
* date span.
*/
public boolean contains(long start, long end) {
return start >= getStart() && end <= getEnd();
}
/**
* Returns true if the this DateSpan intersects with the
* specified time.
*
* @param start Start time
* @param end End time
* @return true if this DateSpan intersects with the specified
* time.
*/
public boolean intersects(long start, long end) {
return start <= getEnd() && end >= getStart();
}
/**
* Returns true if the this DateSpan intersects with the
* specified DateSpan.
*
* @param span DateSpan to compare to
* @return true if this DateSpan intersects with the specified
* time.
*/
public boolean intersects(DateSpan span) {
return intersects(span.getStart(), span.getEnd());
}
/**
* Returns a new DateSpan that is the union of this
* DateSpan and span.
*
* @param span DateSpan to add
* @return union of this DateSpan and span
*/
public DateSpan add(DateSpan span) {
return add(span.getStart(), span.getEnd());
}
/**
* Returns a new DateSpan that is the union of this
* DateSpan and the passed in span.
*
* @param start Start of region to add
* @param end End of region to end
* @return union of this DateSpan and start, end
*/
public DateSpan add(long start, long end) {
return new DateSpan(Math.min(start, getStart()), Math.max(end, getEnd()));
}
/**
* {@inheritDoc}
*/
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (o instanceof DateSpan) {
DateSpan ds = (DateSpan) o;
return start == ds.getStart() && end == ds.getEnd();
}
return false;
}
/**
* {@inheritDoc}
*/
@Override
public int hashCode() {
int result = 17;
result = 37 * result + (int) (start ^ start >>> 32);
result = 37 * result + (int) (end ^ end >>> 32);
return result;
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
return "DateSpan [" + getStartAsDate() + "-" + getEndAsDate() + "]";
}
}