KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > util > docnavigation > INavigatorItem


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
36 /**
37  * <code>INavigatorItem</code> models (very abstractly) some entity that is
38  * eligible for insertion and removal inside an
39  * <code>IDocumentNavigator</code>. Conceptually, if an
40  * <code>IDocumentNavigator</code> represented a file cabinet then each file in
41  * the cabinet would be an <code>INavigatorItem</code>. If an
42  * <code>IDocumentNavigator</code> represented a wallet then each credit card
43  * and driver's license would be an <code>INavigatorItem</code>. <p> The
44  * only real responsibilities a class implementing <code>INavigatorItem</code> has is
45  * to provide a simple <code>String</code> representation of itself via the
46  * <code>getName</code> method and to devise some notion of equality.
47  */

48 public interface INavigatorItem {
49   
50   public boolean checkIfClassFileInSync();
51   public boolean fileExists();
52   
53   /** Returns a "simple" name representing this <code>INavigatorItem</code>.
54    * Strings returned by this method may or may not be unique with respect to other <code>INavigatorItem</code>s within or without
55    * a given <code>IDocumentNavigator</code>.
56    *
57    * @return the simple name for this document.
58    * */

59   public String JavaDoc getName();
60   public boolean isAuxiliaryFile();
61   public boolean inProject();
62   public boolean isUntitled();
63 }
64
Popular Tags