org.sonar.channel
Class Channel<OUTPUT>

java.lang.Object
  extended by org.sonar.channel.Channel<OUTPUT>
Direct Known Subclasses:
ChannelDispatcher, RegexChannel, Tokenizer

public abstract class Channel<OUTPUT>
extends Object


Constructor Summary
Channel()
           
 
Method Summary
abstract  boolean consume(CodeReader code, OUTPUT output)
          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

Channel

public Channel()
Method Detail

consume

public abstract boolean consume(CodeReader code,
                                OUTPUT output)
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.

Parameters:
code - the handle on the input character stream
output - 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.


Copyright © 2009-2012 SonarSource. All Rights Reserved.