edu.rice.cs.drjava.model.definitions.indent
Class QuestionCurrLineIsWingComment

java.lang.Object
  extended by edu.rice.cs.drjava.model.definitions.indent.IndentRuleWithTrace
      extended by edu.rice.cs.drjava.model.definitions.indent.IndentRuleQuestion
          extended by edu.rice.cs.drjava.model.definitions.indent.QuestionCurrLineIsWingComment
All Implemented Interfaces:
IndentRule

public class QuestionCurrLineIsWingComment
extends IndentRuleQuestion

Determines whether or not the current line in the document starts with "//"

Version:
$Id: QuestionCurrLineIsWingComment.java 5236 2010-04-27 01:43:36Z mgricken $

Field Summary
 
Fields inherited from class edu.rice.cs.drjava.model.definitions.indent.IndentRuleWithTrace
NO, TERMINUS_RULE, YES
 
Constructor Summary
QuestionCurrLineIsWingComment(IndentRule yesRule, IndentRule noRule)
           
 
Method Summary
(package private)  boolean applyRule(AbstractDJDocument doc, Indenter.IndentReason reason)
          Determines whether or not the current line in the document starts with the wing comment prefix "//".
 
Methods inherited from class edu.rice.cs.drjava.model.definitions.indent.IndentRuleQuestion
applyRule, indentLine, testApplyRule, testApplyRule, testIndentLine
 
Methods inherited from class edu.rice.cs.drjava.model.definitions.indent.IndentRuleWithTrace
_addToIndentTrace, getRuleName, getTrace, indentLine, printLastIndentTrace, setRuleTraceEnabled, testIndentLine
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QuestionCurrLineIsWingComment

public QuestionCurrLineIsWingComment(IndentRule yesRule,
                                     IndentRule noRule)
Parameters:
yesRule - The decision subtree for the case that this rule applies in the current context.
noRule - The decision subtree for the case that this rule does not apply in the current context.
Method Detail

applyRule

boolean applyRule(AbstractDJDocument doc,
                  Indenter.IndentReason reason)
Determines whether or not the current line in the document starts with the wing comment prefix "//". Does NOT check if this line is embedded in a block comment. Only runs in event thread.

Specified by:
applyRule in class IndentRuleQuestion
Parameters:
doc - The AbstractDJDocument containing the current line.
reason - The reason that the indentation is being done
Returns:
true iff the current line is a wing comment.