IDocumentNavigatorFactory


1   /*BEGIN_COPYRIGHT_BLOCK
2    *
3    * This file is part of DrJava.  Download the current version of this project from http://www.drjava.org/
4    * or http://sourceforge.net/projects/drjava/
5    *
6    * DrJava Open Source License
7    * 
8    * Copyright (C) 2001-2006 JavaPLT group at Rice University (javaplt@rice.edu).  All rights reserved.
9    *
10   * Developed by:   Java Programming Languages Team, Rice University, http://www.cs.rice.edu/~javaplt/
11   * 
12   * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
13   * documentation files (the "Software"), to deal with the Software without restriction, including without limitation
14   * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and 
15   * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
16   * 
17   *     - Redistributions of source code must retain the above copyright notice, this list of conditions and the 
18   *       following disclaimers.
19   *     - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the 
20   *       following disclaimers in the documentation and/or other materials provided with the distribution.
21   *     - Neither the names of DrJava, the JavaPLT, Rice University, nor the names of its contributors may be used to 
22   *       endorse or promote products derived from this Software without specific prior written permission.
23   *     - Products derived from this software may not be called "DrJava" nor use the term "DrJava" as part of their 
24   *       names without prior written permission from the JavaPLT group.  For permission, write to javaplt@rice.edu.
25   * 
26   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO 
27   * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
28   * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
29   * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 
30   * WITH THE SOFTWARE.
31   * 
32   *END_COPYRIGHT_BLOCK*/
33  
34  package edu.rice.cs.util.docnavigation;
35  import edu.rice.cs.plt.tuple.Pair;
36  import java.util.List  ;
37  
38  /** Factory that produces bbjects that implement IDocumentNavigator. */
39  
40  public interface IDocumentNavigatorFactory<ItemT extends INavigatorItem> {
41    
42    /** Creates a new List Navigator
43     *  @return a list navigator
44     */
45    public IDocumentNavigator<ItemT> makeListNavigator();
46    
47    /** Returns a new tree Navigator with the specified root
48     *  @param name the name of the root node
49     *  @return a tree navigator
50     */
51    public IDocumentNavigator<ItemT> makeTreeNavigator(String   name);
52    
53    /** Creates a list navigator and migrates the navigator items from parent to the new navigator
54     *  @param parent the navigator to migrate from
55     *  @return the new list navigator
56     */
57    // Note: parent's type cannot be relaxed with a wildcard.  The type has an upper bound of ItemT,
58    // because the new navigator must be able to contain all of its items; the type has a lower bound
59    // of ItemT, because the parent's listeners must be able to handle all items in the new navigator.
60    public IDocumentNavigator<ItemT> makeListNavigator(IDocumentNavigator<ItemT> parent);
61    
62    /**
63     * creates a tree navigator and migrates the navigator items from the parent to the new navigator
64     * @param name the name of the root node
65     * @param parent the navigator to migrate from
66     * @return the new tree navigator
67     */
68    public IDocumentNavigator<ItemT> makeTreeNavigator(String   name, IDocumentNavigator<ItemT> parent, 
69                                                       List  <Pair<String  , INavigatorItemFilter<ItemT>>> l);
70  }
71
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags