Source for org.jfree.data.time.TimePeriod

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * ---------------
  28:  * TimePeriod.java
  29:  * ---------------
  30:  * (C) Copyright 2003-2005, by Object Refinery Limited and Contributors.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: TimePeriod.java,v 1.3.2.1 2005/10/25 21:35:24 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 10-Jan-2003 : Version 1 (DG);
  40:  * 13-Mar-2003 : Moved to com.jrefinery.data.time package (DG);
  41:  * 27-Jan-2005 : Implemented Comparable (DG);
  42:  *
  43:  */
  44: 
  45: package org.jfree.data.time;
  46: 
  47: import java.util.Date;
  48: 
  49: /**
  50:  * A period of time measured to millisecond precision using two instances of
  51:  * <code>java.util.Date</code>.
  52:  */
  53: public interface TimePeriod extends Comparable {
  54: 
  55:     /**
  56:      * Returns the start date/time.  This will always be on or before the 
  57:      * end date.
  58:      *
  59:      * @return The start date/time (never <code>null</code>).
  60:      */
  61:     public Date getStart();
  62: 
  63:     /**
  64:      * Returns the end date/time.  This will always be on or after the 
  65:      * start date.
  66:      *
  67:      * @return The end date/time (never <code>null</code>).
  68:      */
  69:     public Date getEnd();
  70: 
  71: }