org.sonarsource.analyzer.commons.checks.verifier.CommentParser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-analyzer-test-commons Show documentation

Logic useful to test a language analyzer

The newest version!

/*
 * SonarSource Analyzers Test Commons
 * Copyright (C) 2009-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program 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.
 *
 * This program 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.
 */
package org.sonarsource.analyzer.commons.checks.verifier;

import java.nio.file.Path;
import org.sonarsource.analyzer.commons.checks.verifier.internal.InternalCommentParser;

public interface CommentParser {

  static CommentParser create() {
    return new InternalCommentParser();
  }

  /**
   *    * This comment parser is able split a line using "commentPrefix".
   * But there's some limitation, like for this case in java:
   * String name = "Paul//Smith"; // Noncompliant
   * Example:
   *   parser.addSingleLineCommentSyntax("//");
   * 
   */
  CommentParser addSingleLineCommentSyntax(String commentPrefix);

  /**
   * @param path source file to parse
   * @param verifier verifier for feed
   */
  void parseInto(Path path, MultiFileVerifier verifier);

  /**
   * @param path source file to parse
   * @param verifier verifier for feed
   */
  void parseInto(Path path, SingleFileVerifier verifier);

}