01: /* ========================================================================
02: * JCommon : a free general purpose class library for the Java(tm) platform
03: * ========================================================================
04: *
05: * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
06: *
07: * Project Info: http://www.jfree.org/jcommon/index.html
08: *
09: * 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: * AnnualDateRule.java
29: * -------------------
30: * (C) Copyright 2000-2003, by Object Refinery Limited.
31: *
32: * Original Author: David Gilbert (for Object Refinery Limited);
33: * Contributor(s): -;
34: *
35: * $Id: AnnualDateRule.java,v 1.4 2005/11/16 15:58:40 taqua Exp $
36: *
37: * Changes (from 26-Oct-2001)
38: * --------------------------
39: * 26-Oct-2001 : Changed package to com.jrefinery.date.* (DG);
40: * 12-Nov-2001 : Javadoc comments updated (DG);
41: * 03-Oct-2002 : Fixed errors reported by Checkstyle (DG);
42: *
43: */
44:
45: package org.jfree.date;
46:
47: /**
48: * The base class for all 'annual' date rules: that is, rules for generating
49: * one date for any given year.
50: * <P>
51: * One example is Easter Sunday (which can be calculated using published algorithms).
52: *
53: * @author David Gilbert
54: */
55: public abstract class AnnualDateRule implements Cloneable {
56:
57: /**
58: * Default constructor.
59: */
60: protected AnnualDateRule() {
61: }
62:
63: /**
64: * Returns the date for this rule, given the year.
65: *
66: * @param year the year (1900 <= year <= 9999).
67: *
68: * @return the date for this rule, given the year.
69: */
70: public abstract SerialDate getDate(int year);
71:
72: /**
73: * Returns a clone of the rule.
74: * <P>
75: * You should refer to the documentation of the clone() method in each
76: * subclass for exact details.
77: *
78: * @return a clone of the rule.
79: *
80: * @throws CloneNotSupportedException if the rule is not clonable.
81: */
82: public Object clone() throws CloneNotSupportedException {
83: return super.clone();
84: }
85:
86: }
|