A B C D E F G I L M O P R S T

A

addChannel(Channel) - Method in class org.sonar.channel.ChannelDispatcher.Builder

addChannels(Channel...) - Method in class org.sonar.channel.ChannelDispatcher.Builder

addCodeReaderFilters(CodeReaderFilter<?>) - Method in class org.sonar.channel.CodeReaderConfiguration

Adds a code reader filter

B

build() - Method in class org.sonar.channel.ChannelDispatcher.Builder

builder() - Static method in class org.sonar.channel.ChannelDispatcher

Get a Builder instance to build a new ChannelDispatcher

C

Channel<O> - Class in org.sonar.channel

Channel() - Constructor for class org.sonar.channel.Channel

ChannelCodeReaderFilter<O> - Class in org.sonar.channel

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.

ChannelCodeReaderFilter(Channel<O>...) - Constructor for class org.sonar.channel.ChannelCodeReaderFilter

Creates a CodeReaderFilter that will use the provided Channels to filter the character stream it gets from its reader.

ChannelCodeReaderFilter(O, Channel<O>...) - Constructor for class org.sonar.channel.ChannelCodeReaderFilter

Creates a CodeReaderFilter that will use the provided Channels to filter the character stream it gets from its reader.

ChannelDispatcher<O> - Class in org.sonar.channel

ChannelDispatcher(List<Channel>) - Constructor for class org.sonar.channel.ChannelDispatcher

Deprecated.

in version 2.9. Please use the builder() method

ChannelDispatcher(Channel...) - Constructor for class org.sonar.channel.ChannelDispatcher

Deprecated.

in version 2.9. Please use the builder() method

ChannelDispatcher(List<Channel>, boolean) - Constructor for class org.sonar.channel.ChannelDispatcher

Deprecated.

in version 2.9. Please use the builder() method

ChannelDispatcher.Builder - Class in org.sonar.channel

ChannelException - Exception in org.sonar.channel

ChannelException(String, Exception) - Constructor for exception org.sonar.channel.ChannelException

ChannelException(String) - Constructor for exception org.sonar.channel.ChannelException

ChannelException(String, Throwable) - Constructor for exception org.sonar.channel.ChannelException

charAt(int) - Method in class org.sonar.channel.CodeBuffer

Returns the character at the specified index after the cursor without consuming it

clone() - Method in class org.sonar.channel.CodeBuffer.Cursor

cloneWithoutCodeReaderFilters() - Method in class org.sonar.channel.CodeReaderConfiguration

CodeBuffer - Class in org.sonar.channel

The CodeBuffer class provides all the basic features required to manipulate a source code character stream.

CodeBuffer(String, CodeReaderConfiguration) - Constructor for class org.sonar.channel.CodeBuffer

CodeBuffer(Reader, CodeReaderConfiguration) - Constructor for class org.sonar.channel.CodeBuffer

Note that this constructor will read everything from reader and will close it.

CodeBuffer.Cursor - Class in org.sonar.channel

CodeBuffer.Cursor() - Constructor for class org.sonar.channel.CodeBuffer.Cursor

CodeReader - Class in org.sonar.channel

The CodeReader class provides some advanced features to read a source code.

CodeReader(Reader) - Constructor for class org.sonar.channel.CodeReader

CodeReader(String) - Constructor for class org.sonar.channel.CodeReader

CodeReader(Reader, CodeReaderConfiguration) - Constructor for class org.sonar.channel.CodeReader

Creates a code reader with specific configuration parameters.

CodeReader(String, CodeReaderConfiguration) - Constructor for class org.sonar.channel.CodeReader

Creates a code reader with specific configuration parameters.

CodeReaderConfiguration - Class in org.sonar.channel

Configuration parameters used by a CodeReader to handle some specificities.

CodeReaderConfiguration() - Constructor for class org.sonar.channel.CodeReaderConfiguration

CodeReaderFilter<O> - Class in org.sonar.channel

This class can be extended to provide filtering capabilities for the CodeReader class.

CodeReaderFilter() - Constructor for class org.sonar.channel.CodeReaderFilter

CodeReaderFilter(O) - Constructor for class org.sonar.channel.CodeReaderFilter

consume(CodeReader, O) - Method in class org.sonar.channel.Channel

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

consume(CodeReader, O) - Method in class org.sonar.channel.ChannelDispatcher

consume(CodeReader, O) - Method in class org.sonar.channel.RegexChannel

consume(CharSequence, O) - Method in class org.sonar.channel.RegexChannel

The consume method is called each time the regular expression used to create the RegexChannel object matches the next characters in the character streams.

D

DEFAULT_BUFFER_CAPACITY - Static variable in class org.sonar.channel.CodeReaderConfiguration

Deprecated.

in 2.12, do not use anymore.

DEFAULT_TAB_WIDTH - Static variable in class org.sonar.channel.CodeReaderConfiguration

E

EndMatcher - Interface in org.sonar.channel

F

failIfNoChannelToConsumeOneCharacter() - Method in class org.sonar.channel.ChannelDispatcher.Builder

If this option is activated, an IllegalStateException will be thrown as soon as a character won't be consumed by any channel.

G

getBufferCapacity() - Method in class org.sonar.channel.CodeReaderConfiguration

Deprecated.

in 2.12, do not use anymore.

getCodeReaderFilters() - Method in class org.sonar.channel.CodeReaderConfiguration

getColumn() - Method in class org.sonar.channel.CodeBuffer.Cursor

getColumnPosition() - Method in class org.sonar.channel.CodeBuffer

getConfiguration() - Method in class org.sonar.channel.CodeReaderFilter

Returns the configuration used for the CodeReader

getCursor() - Method in class org.sonar.channel.CodeBuffer

getLine() - Method in class org.sonar.channel.CodeBuffer.Cursor

getLinePosition() - Method in class org.sonar.channel.CodeBuffer

getOutput() - Method in class org.sonar.channel.CodeReaderFilter

Returns the output object.

getPreviousCursor() - Method in class org.sonar.channel.CodeReader

getReader() - Method in class org.sonar.channel.CodeReaderFilter

Returns the reader from which this class reads the character stream.

getTabWidth() - Method in class org.sonar.channel.CodeReaderConfiguration

I

intAt(int) - Method in class org.sonar.channel.CodeBuffer

L

lastChar() - Method in class org.sonar.channel.CodeBuffer

Looks at the last consumed character

length() - Method in class org.sonar.channel.CodeBuffer

Returns the relative length of the string (i.e.

M

match(int) - Method in interface org.sonar.channel.EndMatcher

O

org.sonar.channel - package org.sonar.channel

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

P

peek() - Method in class org.sonar.channel.CodeBuffer

Looks at the next character without consuming it

peek(int) - Method in class org.sonar.channel.CodeReader

Read without consuming the next characters

peekTo(EndMatcher, Appendable) - Method in class org.sonar.channel.CodeReader

Read without consuming the next characters until a condition is reached (EndMatcher)

peekTo(EndMatcher) - Method in class org.sonar.channel.CodeReader

Deprecated.

in 2.2, use CodeReader.peekTo(EndMatcher matcher, Appendable appendable) instead

pop() - Method in class org.sonar.channel.CodeBuffer

Read and consume the next character

pop(Appendable) - Method in class org.sonar.channel.CodeReader

Read and consume the next character

popTo(EndMatcher, Appendable) - Method in class org.sonar.channel.CodeReader

Deprecated.

in 2.2, use CodeReader.popTo(Matcher matcher, Appendable appendable) instead

popTo(Matcher, Appendable) - Method in class org.sonar.channel.CodeReader

Read and consume the next characters according to a given regular expression

popTo(Matcher, Matcher, Appendable) - Method in class org.sonar.channel.CodeReader

Read and consume the next characters according to a given regular expression.

R

read(char[], int, int) - Method in class org.sonar.channel.ChannelCodeReaderFilter

This method implements the filtering logic, that is: get the characters from the reader, filter the character flow (and grab more characters from the reader if the filtering removes some), and fill the given buffer to its full capacity with the filtered data.

read(char[], int, int) - Method in class org.sonar.channel.CodeReaderFilter

This method implements the filtering logic, that is: get the characters from the reader, filter the character flow (and grab more characters from the reader if the filtering removes some), and fill the given buffer to its full capacity with the filtered data.

RegexChannel<O> - Class in org.sonar.channel

The RegexChannel can be used to be called each time the next characters in the character stream match a regular expression

RegexChannel(String) - Constructor for class org.sonar.channel.RegexChannel

Create a RegexChannel object with the required regular expression

S

setBufferCapacity(int) - Method in class org.sonar.channel.CodeReaderConfiguration

Deprecated.

in 2.12, do not use anymore.

setCodeReaderFilters(CodeReaderFilter<?>...) - Method in class org.sonar.channel.CodeReaderConfiguration

setColumnPosition(int) - Method in class org.sonar.channel.CodeBuffer

Overrides the current column position

setConfiguration(CodeReaderConfiguration) - Method in class org.sonar.channel.CodeReaderFilter

Sets the configuration that must be used by the CodeReader

setLinePosition(int) - Method in class org.sonar.channel.CodeBuffer

Overrides the current line position

setOutput(O) - Method in class org.sonar.channel.CodeReaderFilter

Sets the output object

setReader(Reader) - Method in class org.sonar.channel.ChannelCodeReaderFilter

Sets the reader from which this class will read the character stream.

setReader(Reader) - Method in class org.sonar.channel.CodeReaderFilter

Sets the reader from which this class will read the character stream.

setTabWidth(int) - Method in class org.sonar.channel.CodeReaderConfiguration

startRecording() - Method in class org.sonar.channel.CodeBuffer

stopRecording() - Method in class org.sonar.channel.CodeBuffer

subSequence(int, int) - Method in class org.sonar.channel.CodeBuffer

T

toString() - Method in class org.sonar.channel.CodeBuffer

A B C D E F G I L M O P R S T