KickJava   Java API By Example, From Geeks To Geeks.

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


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.*;
37 import edu.rice.cs.util.UnexpectedException;
38
39 import edu.rice.cs.drjava.model.AbstractDJDocument;
40
41 /** Question rule in the indentation decision tree. Determines if the
42   * next non-whitespace character is a star '*'. This is useful for determining
43   * if we are at the beginning of a previously ill-formed block comment.
44   * <p>
45   * <b>Does not work if character being searched for is a '/' or a '*'</b>
46   *
47   * @version $Id: QuestionFollowedByStar.java 3901 2006-06-30 05:28:11Z rcartwright $
48   */
49 public class QuestionFollowedByStar extends IndentRuleQuestion {
50   
51   /** Constructs a new rule which determines if the current position is
52     * immediately followed by a star '*'.
53     * @param yesRule Rule to use if this rule holds
54     * @param noRule Rule to use if this rule does not hold
55     */
56   public QuestionFollowedByStar(IndentRule yesRule, IndentRule noRule) { super(yesRule, noRule); }
57   
58   /** Determines if the next non WS character is '*'. Does not search in quotes or comments.
59    * <p>
60    * <b>Does not work if character being searched for is a '/' or a '*'</b>
61    * @param doc AbstractDJDocument containing the line to be indented.
62    * @return true if this node's rule holds.
63    */
64   boolean applyRule(AbstractDJDocument doc, int reason) {
65     try {
66       int charPos = doc.getFirstNonWSCharPos(doc.getCurrentLocation(), true);
67       
68       return !(charPos == AbstractDJDocument.ERROR_INDEX) && doc.getText(charPos, 1).equals("*");
69     }
70     catch (BadLocationException ble) { throw new UnexpectedException(ble); }
71   }
72 }
73
74
Popular Tags