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.docnavigation;
38:
39: import edu.rice.cs.plt.tuple.Pair;
40: import java.util.List;
41:
42: /** Factory that produces bbjects that implement IDocumentNavigator. */
43:
44: public interface IDocumentNavigatorFactory<ItemT extends INavigatorItem> {
45:
46: /** Creates a new List Navigator
47: * @return a list navigator
48: */
49: public IDocumentNavigator<ItemT> makeListNavigator();
50:
51: /** Returns a new tree Navigator with the specified root
52: * @param name the name of the root node
53: * @return a tree navigator
54: */
55: public IDocumentNavigator<ItemT> makeTreeNavigator(String name);
56:
57: /** Creates a list navigator and migrates the navigator items from parent to the new navigator
58: * @param parent the navigator to migrate from
59: * @return the new list navigator
60: */
61: // Note: parent's type cannot be relaxed with a wildcard. The type has an upper bound of ItemT,
62: // because the new navigator must be able to contain all of its items; the type has a lower bound
63: // of ItemT, because the parent's listeners must be able to handle all items in the new navigator.
64: public IDocumentNavigator<ItemT> makeListNavigator(
65: IDocumentNavigator<ItemT> parent);
66:
67: /**
68: * creates a tree navigator and migrates the navigator items from the parent to the new navigator
69: * @param name the name of the root node
70: * @param parent the navigator to migrate from
71: * @return the new tree navigator
72: */
73: public IDocumentNavigator<ItemT> makeTreeNavigator(String name,
74: IDocumentNavigator<ItemT> parent,
75: List<Pair<String, INavigatorItemFilter<ItemT>>> l);
76: }
|