KickJava   Java API By Example, From Geeks To Geeks.

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


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 edu.rice.cs.drjava.model.AbstractDJDocument;
37
38 /**
39  * Question rule in the indentation decision tree. Determines if the
40  * current line contains the given character. Does not check
41  * for the character inside comments or quotes.
42  * <p>
43  * <b>Does not work if character being searched for is a '/' or a '*'</b>
44  *
45  * @version $Id: QuestionLineContains.java 3901 2006-06-30 05:28:11Z rcartwright $
46  */
47 public class QuestionLineContains extends IndentRuleQuestion {
48   /**
49    * Character to search for
50    */
51   private char _findChar;
52   
53   /**
54    * Constructs a new rule which determines if the line
55    * contains the given character.
56    * @param findChar Character to search for
57    * @param yesRule Rule to use if this rule holds
58    * @param noRule Rule to use if this rule does not hold
59    */
60   public QuestionLineContains(char findChar, IndentRule yesRule, IndentRule noRule) {
61     super(yesRule, noRule);
62     _findChar = findChar;
63   }
64   
65   /**
66    * Determines if the given character exists on the current line.
67    * Does not search in quotes or comments.
68    * <p>
69    * <b>Does not work if character being searched for is a '/' or a '*'</b>
70    * @param doc AbstractDJDocument containing the line to be indented.
71    * @return true if this node's rule holds.
72    */
73   boolean applyRule(AbstractDJDocument doc, int reason) {
74
75     int charPos = doc.findCharOnLine(doc.getCurrentLocation(), _findChar);
76     if (charPos == AbstractDJDocument.ERROR_INDEX) {
77       return false;
78     } else {
79       return true;
80     }
81   }
82 }
83
84
Popular Tags