<commit_before>package se.bjurr.violations.comments.lib.model;

import java.util.List;
import se.bjurr.violations.lib.util.Optional;

public interface CommentsProvider {
  void createCommentWithAllSingleFileComments(String string);

  void createSingleFileComment(ChangedFile file, Integer line, String comment);

  List<Comment> getComments();

  List<ChangedFile> getFiles();

  void removeComments(List<Comment> comments);

  boolean shouldComment(ChangedFile changedFile, Integer line);

  boolean shouldCreateCommentWithAllSingleFileComments();

  boolean shouldCreateSingleFileComment();

  boolean shouldKeepOldComments();

  Optional<String> findCommentTemplate();<commit_msg>Add javadoc.<commit_after>package se.bjurr.violations.comments.lib.model;

import java.util.List;
import se.bjurr.violations.lib.util.Optional;

public interface CommentsProvider {

  /**
   * Create a single comment containing all file comments and violations.
   *
   * @param string The combined comments.
   */
  void createCommentWithAllSingleFileComments(String string);

  /**
   * Create a discussion on the diff on the line the violation occurred.
   *
   * @param file The file in which the violation occurred.
   * @param line The line number after the patch.
   * @param comment The text of the comment.
   */
  void createSingleFileComment(ChangedFile file, Integer line, String comment);

  List<Comment> getComments();

  List<ChangedFile> getFiles();

  void removeComments(List<Comment> comments);

  boolean shouldComment(ChangedFile changedFile, Integer line);

  boolean shouldCreateCommentWithAllSingleFileComments();

  boolean shouldCreateSingleFileComment();

  boolean shouldKeepOldComments();

  Optional<String> findCommentTemplate();
{'fraction_non_alphanumeric': 0.08538681948424069, 'fraction_numerical': 0.0, 'mean_word_length': 5.349090909090909, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5014370', 'n_tokens_mistral': 486, 'n_tokens_neox': 445, 'n_words': 129}