org.sonar.colorizer

Class MultilinesDocTokenizer

java.lang.Object

org.sonar.channel.Channel<HtmlCodeBuilder>

org.sonar.colorizer.Tokenizer

org.sonar.colorizer.MultilinesDocTokenizer

Direct Known Subclasses:

CppDocTokenizer, JavadocTokenizer

public class MultilinesDocTokenizer
extends Tokenizer

Constructor Summary

Constructors

Constructor and Description
MultilinesDocTokenizer(String startToken, String tagBefore, String tagAfter) Deprecated. endToken is hardcoded to star-slash, whatever the startToken !
MultilinesDocTokenizer(String startToken, String endToken, String tagBefore, String tagAfter)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	consume(CodeReader code, HtmlCodeBuilder codeBuilder) Tries to consume the character stream at the current reading cursor position (provided by the CodeReader).
boolean	hasNextToken(CodeReader code, HtmlCodeBuilder codeBuilder)

Methods inherited from class java.lang.Object

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

Constructor Detail

MultilinesDocTokenizer

@Deprecated
public MultilinesDocTokenizer(String startToken,
                                 String tagBefore,
                                 String tagAfter)

Deprecated. endToken is hardcoded to star-slash, whatever the startToken !

MultilinesDocTokenizer

public MultilinesDocTokenizer(String startToken,
                      String endToken,
                      String tagBefore,
                      String tagAfter)

Method Detail

hasNextToken

public boolean hasNextToken(CodeReader code,
                   HtmlCodeBuilder codeBuilder)

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.