AnnualDateRule.java 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. /* ========================================================================
  2. * JCommon : a free general purpose class 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/jcommon/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. * 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. package org.jfree.date;
  45. /**
  46. * The base class for all 'annual' date rules: that is, rules for generating
  47. * one date for any given year.
  48. * <P>
  49. * One example is Easter Sunday (which can be calculated using published algorithms).
  50. *
  51. * @author David Gilbert
  52. */
  53. public abstract class AnnualDateRule implements Cloneable {
  54. /**
  55. * Default constructor.
  56. */
  57. protected AnnualDateRule() {
  58. }
  59. /**
  60. * Returns the date for this rule, given the year.
  61. *
  62. * @param year the year (1900 &lt;= year &lt;= 9999).
  63. *
  64. * @return the date for this rule, given the year.
  65. */
  66. public abstract SerialDate getDate(int year);
  67. /**
  68. * Returns a clone of the rule.
  69. * <P>
  70. * You should refer to the documentation of the clone() method in each
  71. * subclass for exact details.
  72. *
  73. * @return a clone of the rule.
  74. *
  75. * @throws CloneNotSupportedException if the rule is not clonable.
  76. */
  77. public Object clone() throws CloneNotSupportedException {
  78. return super.clone();
  79. }
  80. }