View Javadoc

1   /*
2    *  File: NamedDate.java 
3    *  Copyright (c) 2004-2007  Peter Kliem (Peter.Kliem@jaret.de)
4    *  A commercial license is available, see http://www.jaret.de.
5    *
6    * All rights reserved. This program and the accompanying materials
7    * are made available under the terms of the Common Public License v1.0
8    * which accompanies this distribution, and is available at
9    * http://www.eclipse.org/legal/cpl-v10.html
10   */
11  package de.jaret.util.date.holidayenumerator;
12  
13  import java.util.Date;
14  
15  /**
16   * Interface for the combintaion of a date and a name for the date. As an additional information the date can be
17   * categorized to be a holiday.
18   * 
19   * @author Peter Kliem
20   * @version $Id: NamedDate.java 242 2007-02-11 21:05:07Z olk $
21   */
22  public interface NamedDate extends Comparable<NamedDate> {
23      /**
24       * Retrive the name of the date.
25       * 
26       * @return name of the date
27       */
28      String getName();
29  
30      /**
31       * Retrieve the date.
32       * 
33       * @return date
34       */
35      Date getDate();
36  
37      /**
38       * Return whether the day is marked as a holiday.
39       * 
40       * @return tre for holiday
41       */
42      boolean isHoliday();
43  }