KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > model > StaticDocumentRegion


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-2005 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.drjava.model;
35
36 import java.io.File JavaDoc;
37 import java.lang.ref.WeakReference JavaDoc;
38 import javax.swing.text.Position JavaDoc;
39
40 /**
41  * Class for a document region that remains static all the time and does not respond to changes in the document.
42  * @version $Id$Region
43  */
44 public class StaticDocumentRegion implements DocumentRegion {
45   protected final OpenDefinitionsDocument _doc;
46   protected final File JavaDoc _file;
47   protected final int _startOffset;
48   protected final int _endOffset;
49   protected final String JavaDoc _string;
50   
51   /** Create a new static document region. */
52   public StaticDocumentRegion(OpenDefinitionsDocument doc, File JavaDoc file, int so, int eo, String JavaDoc s) {
53     _doc = doc;
54     _file = file;
55     _startOffset = so;
56     _endOffset = eo;
57     _string = s;
58   }
59   
60   /** @return the document, or null if it hasn't been established yet */
61   public OpenDefinitionsDocument getDocument() { return _doc; }
62
63   /** @return the file */
64   public File JavaDoc getFile() { return _file; }
65
66   /** @return the start offset */
67   public int getStartOffset() {
68     return ((_doc==null)||(_doc.getLength()>=_startOffset))?_startOffset:_doc.getLength();
69   }
70
71   /** @return the end offset */
72   public int getEndOffset() {
73     return ((_doc==null)||(_doc.getLength()>=_endOffset))?_endOffset:_doc.getLength();
74   }
75   
76   /** @return the string it was assigned */
77   public String JavaDoc getString() {
78     return _string;
79   }
80   
81   /** @return true if the specified region is equal to this one. */
82   public boolean equals(Object JavaDoc other) {
83     if (!(other instanceof StaticDocumentRegion) || (other==null)) return false;
84     StaticDocumentRegion o = (StaticDocumentRegion)other;
85     return ((((_doc==null) && (o._doc==null)) || (_doc.equals(o._doc))) &&
86             (((_file==null) && (o._file==null)) || (_file.equals(o._file))) &&
87             (_startOffset == o._startOffset) &&
88             (_endOffset == o._endOffset) &&
89             (_string.equals(o._string)));
90   }
91   
92   public String JavaDoc toString() {
93     return ((_doc!=null)?_doc.toString():"null") + " "+_startOffset+" .. "+_endOffset;
94   }
95 }
96
Popular Tags