1 // re/mind - Remote Reminder Software
2 // Copyright (C) 2002 Moritz Petersen
3 //
4 // This program is free software; you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation; either version 2 of the License, or
7 // (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 //
18 // $Id: NoteContainer.java,v 1.1 2002/09/29 19:33:23 powerpete Exp $
19 package de.jface.remind.core;
20
21 /***
22 * The <code>NoteContainer</code> is used as a container,
23 * to save the notes using a {@link Storage} object.
24 * It is not derived from the Java Collections API, because
25 * it is important, that this container contains <em>only</em>
26 * objects of type {@link Note}. It is a kind of typed
27 * Collection.
28 * <p>
29 * There is no guarantee, that the order of the notes remains
30 * constant over time.
31 *
32 * @author Moritz Petersen
33 * @version $Revision: 1.1 $
34 */
35 public interface NoteContainer
36 {
37 /***
38 * Adds a note to the container.
39 *
40 * @param note the note that is newly added to the container.
41 */
42 public void addNote(Note note);
43
44 /***
45 * Removes all notes from the container.
46 */
47 public void clear();
48
49 /***
50 * Returns an iterator, that returns all notes.
51 */
52 public NoteIterator getNoteIterator();
53
54 /***
55 * Removes the specific note from the container.
56 *
57 * @param note the note that will be removed.
58 */
59 public void remove(Note note);
60 }
This page was automatically generated by Maven