Package org.sonar.channel

Provides a basic framework to sequentially read any kind of character stream in order to feed a generic OUTPUT.

See:
          Description

Interface Summary
EndMatcher  
 

Class Summary
Channel<OUTPUT>  
ChannelCodeReaderFilter<OUTPUT> This class is a special CodeReaderFilter that uses Channels to filter the character stream before it is passed to the main channels declared for the CodeReader.
ChannelDispatcher<OUTPUT>  
ChannelDispatcher.Builder  
CodeBuffer The CodeBuffer class provides all the basic features required to manipulate a source code character stream.
CodeReader The CodeReader class provides some advanced features to read a source code.
CodeReaderConfiguration Configuration parameters used by a CodeReader to handle some specificities.
CodeReaderFilter<OUTPUT> This class can be extended to provide filtering capabilities for the CodeReader class.
RegexChannel<OUTPUT> The RegexChannel can be used to be called each time the next characters in the character stream match a regular expression
 

Exception Summary
ChannelException  
 

Package org.sonar.channel Description

Provides a basic framework to sequentially read any kind of character stream in order to feed a generic OUTPUT. This framework can used for instance in order to :

The entry point of this framework is the ChannelDispatcher class. This class must be initialized with a CodeReader and a list of Channel. The CodeReader encapsulates any character stream in order to provide all mechanisms to Channels in order to look ahead and look behind the current reading cursor position. A Channel is in charge to consume the character stream through the CodeReader in order to feed the OUTPUT.



Copyright © 2009-2012 SonarSource. All Rights Reserved.