org.sonar.colorizer
Class InlineDocTokenizer

java.lang.Object
  org.sonar.channel.Channel<HtmlCodeBuilder>
      org.sonar.colorizer.Tokenizer
          org.sonar.colorizer.InlineDocTokenizer

Direct Known Subclasses:

CDocTokenizer

public abstract class InlineDocTokenizer
extends Tokenizer

Constructor Summary

InlineDocTokenizer(String startToken, String tagBefore, String tagAfter)

Method Summary

boolean

consume(CodeReader code, HtmlCodeBuilder codeBuilder) Tries to consume the character stream at the current reading cursor position (provided by the CodeReader).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InlineDocTokenizer

public InlineDocTokenizer(String startToken,
                          String tagBefore,
                          String tagAfter)

Method Detail

consume

public boolean consume(CodeReader code,
                       HtmlCodeBuilder codeBuilder)

Description copied from class: Channel

Tries to consume the character stream at the current reading cursor position (provided by the CodeReader). If the character stream is consumed the method must return true and the OUTPUT object can be fed.

Specified by:

consume in class Channel<HtmlCodeBuilder>

Parameters:

code - the handle on the input character stream

codeBuilder - the OUTPUT that can be optionally fed by the Channel

Returns:

false if the Channel doesn't want to consume the character stream, true otherwise.