com.sonar.sslr.impl.channel

Class CommentRegexpChannel

java.lang.Object

org.sonar.sslr.channel.Channel<Lexer>

com.sonar.sslr.impl.channel.CommentRegexpChannel

public class CommentRegexpChannel
extends Channel<Lexer>

Creates comment trivia from characters, which match given regular expression.

See Also:

RegexpChannelBuilder

Constructor Summary

Constructors

Constructor and Description
CommentRegexpChannel(String regexp)

Method Summary

Modifier and Type	Method and Description
boolean	consume(CodeReader code, Lexer lexer) 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

CommentRegexpChannel

public CommentRegexpChannel(String regexp)

Method Detail

consume

public boolean consume(CodeReader code,
                       Lexer lexer)

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<Lexer>

Parameters:

code - the handle on the input character stream

lexer - 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.