KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > model > definitions > indent > QuestionCurrLineIsWingComment


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.drjava.model.definitions.indent;
35
36 import javax.swing.text.BadLocationException JavaDoc;
37
38 import edu.rice.cs.util.UnexpectedException;
39 import edu.rice.cs.drjava.model.AbstractDJDocument;
40
41
42 /** Determines whether or not the current line in the document starts with "//"
43  * @version $Id: QuestionCurrLineIsWingComment.java 3901 2006-06-30 05:28:11Z rcartwright $
44  */
45 public class QuestionCurrLineIsWingComment extends IndentRuleQuestion {
46   
47   /** @param yesRule The decision subtree for the case that this rule applies in the current context.
48    * @param noRule The decision subtree for the case that this rule does not apply in the current context.
49    */
50   public QuestionCurrLineIsWingComment(IndentRule yesRule, IndentRule noRule) { super(yesRule, noRule); }
51   
52   /** Determines whether or not the current line in the document starts with the wing comment prefix "//".
53    * Does not test to determine if this line is embedded in a block comment.
54    * @param doc The AbstractDJDocument containing the current line.
55    * @return true iff the current line is a wing comment.
56    * @pre current line is not embedded in a block comment
57    */
58   boolean applyRule(AbstractDJDocument doc, int reason) {
59     try {
60       // Find the first non-whitespace character on the current line.
61
62       int currentPos = doc.getCurrentLocation();
63       int startPos = doc.getLineStartPos(currentPos);
64       int maxPos = doc.getLength();
65       int diff = maxPos - startPos;
66       
67       if (diff < 2) return false;
68       
69       String JavaDoc text = doc.getText(startPos, 2);
70       
71       return text.equals("//");
72     }
73     catch (BadLocationException JavaDoc e) { throw new UnexpectedException();
74     }
75   }
76   
77 }
Popular Tags