View Javadoc

1   /*
2    *  File: IIteratorFormatter.java 
3    *  Copyright (c) 2004-2009  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.iterator;
12  
13  import de.jaret.util.date.JaretDate;
14  
15  /**
16   * Interface used to decsribe a simple formatter for date iterators.
17   * 
18   * @author kliem
19   * @version $Id: IIteratorFormatter.java 829 2009-02-08 14:00:40Z kliem $
20   */
21  public interface IIteratorFormatter {
22      /**
23       * Provide a formatted output for a given date.
24       * 
25       * @param date date to format
26       * @param format format (short, medium, long)
27       * @return the formatted date as String
28       */
29      String getLabel(JaretDate date, DateIterator.Format format);
30  }