org.sonar.channel.package-info Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sonarlint-core Show documentation

Common library used by some SonarLint flavors

There is a newer version: 10.5.0.78949

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2013 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
/**
 * 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 :
 * 
 *   Create a lexer in charge to generate a list of tokens from a character stream
 *   Create a source code syntax highligther in charge to decorate a source code with HTML tags
 *   Create a javadoc generator
 *   ...
 *  
 * 
 * The entry point of this framework is the {@link org.sonar.channel.ChannelDispatcher} class. 
 * This class must be initialized with a {@link org.sonar.channel.CodeReader} and a list of {@link org.sonar.channel.Channel}.
 * 
 * The {@link org.sonar.channel.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 {@link org.sonar.channel.Channel} is in charge to consume the character stream through the CodeReader in order to feed
 * the OUTPUT.
 */
package org.sonar.channel;