01: /*BEGIN_COPYRIGHT_BLOCK
02: *
03: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
04: * All rights reserved.
05: *
06: * Redistribution and use in source and binary forms, with or without
07: * modification, are permitted provided that the following conditions are met:
08: * * Redistributions of source code must retain the above copyright
09: * notice, this list of conditions and the following disclaimer.
10: * * Redistributions in binary form must reproduce the above copyright
11: * notice, this list of conditions and the following disclaimer in the
12: * documentation and/or other materials provided with the distribution.
13: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
14: * names of its contributors may be used to endorse or promote products
15: * derived from this software without specific prior written permission.
16: *
17: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28: *
29: * This software is Open Source Initiative approved Open Source Software.
30: * Open Source Initative Approved is a trademark of the Open Source Initiative.
31: *
32: * This file is part of DrJava. Download the current version of this project
33: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
34: *
35: * END_COPYRIGHT_BLOCK*/
36:
37: package edu.rice.cs.util.swing;
38:
39: import edu.rice.cs.drjava.model.OpenDefinitionsDocument; // TODO: move this class to the model package
40:
41: import edu.rice.cs.util.text.AbstractDocumentInterface;
42:
43: /** Used to get the next or previous open document given the current one. */
44: public interface DocumentIterator {
45: /** Gets the next document.
46: * @param doc the current document.
47: * @return the next document.
48: */
49: OpenDefinitionsDocument getNextDocument(OpenDefinitionsDocument doc);
50:
51: /** Gets the previous document.
52: * @param doc the current document.
53: * @return the previous document.
54: */
55: OpenDefinitionsDocument getPrevDocument(OpenDefinitionsDocument doc);
56:
57: /** @return the number of documents being iterated over */
58: int getDocumentCount();
59: }
|