refactoring of CommentTextProcessor api

Author: raydac

jcp/src/main/java/com/igormaznitsa/jcp/containers/FileInfoContainer.java

@@ -456,9 +456,9 @@ private void flushTextBufferForRemovedComments(
           try {
             final FilePositionInfo filePositionInfo =
                 new FilePositionInfo(this.sourceFile, stringIndex);
-            final String result = x.onUncommentText(
+            final String result = x.processUncommentedText(
                 firstUncommentLine == null ? 0 : firstUncommentLine.getKey().length(), origText,
-                filePositionInfo, this, context, state);
+                this, filePositionInfo, context, state);
             textBuffer.append(result);
           } catch (Exception ex) {
             throw new PreprocessorException(

jcp/src/main/java/com/igormaznitsa/jcp/context/CommentTextProcessor.java

@@ -2,7 +2,6 @@
 
 import com.igormaznitsa.jcp.containers.FileInfoContainer;
 import com.igormaznitsa.jcp.exceptions.FilePositionInfo;
-import java.io.IOException;
 
 /**
  * Custom processor to detect and process uncommenting text line or text block
@@ -16,23 +15,21 @@
 public interface CommentTextProcessor extends PreprocessorContextListener {
 
   /**
-   * Process text value.
+   * Process uncommented text detected in //$ or //$$ sections. If processing not needed then the provided text must be returned.
    *
-   * @param firstLineIndent   detected indent for the first line during accumulation
-   * @param text              the source text
-   * @param filePositionInfo  position of the uncommented line or the first line of the uncommented text block
-   * @param fileInfoContainer the source file info container, must not be null
-   * @param context           the source preprocessor context, must not be null
+   * @param recommendedIndent indent to be recommended for the processed text if it will be processed
+   * @param uncommentedText   the text which was uncommented and needs processing, must not be null
+   * @param fileContainer     the source file info container calling the processor, must not be null
+   * @param positionInfo      position of the uncommented line or the first line of the uncommented text block, must not be null
+   * @param context           the current preprocessor context, must not be null
    * @param state             the current preprocess state, must not be null
    * @return must return value as the same text or as the changed one.
-   * @throws IOException if any IO error during operation
    * @since 7.2.1
    */
-  String onUncommentText(
-      int firstLineIndent,
-      String text,
-      FilePositionInfo filePositionInfo,
-      FileInfoContainer fileInfoContainer,
+  String processUncommentedText(
+      int recommendedIndent,
+      String uncommentedText,
+      FileInfoContainer fileContainer, FilePositionInfo positionInfo,
       PreprocessorContext context,
-      PreprocessingState state) throws IOException;
+      PreprocessingState state);
 }

jcp/src/test/java/com/igormaznitsa/jcp/directives/SpecialDirectivesBlockTest.java

@@ -62,21 +62,21 @@ public void onContextStopped(PreprocessorContext context, Throwable error) {
       }
 
       @Override
-      public String onUncommentText(int firstLineIndent, String text,
-                                    FilePositionInfo filePositionInfo,
-                                    FileInfoContainer fileInfoContainer,
-                                    PreprocessorContext context, PreprocessingState state) {
-        assertTrue(filePositionInfo.getLineNumber() >= 0);
-        assertNotNull(text);
-        assertNotNull(fileInfoContainer);
+      public String processUncommentedText(int recommendedIndent, String uncommentedText,
+                                           FileInfoContainer fileContainer,
+                                           FilePositionInfo positionInfo,
+                                           PreprocessorContext context, PreprocessingState state) {
+        assertTrue(positionInfo.getLineNumber() >= 0);
+        assertNotNull(uncommentedText);
+        assertNotNull(fileContainer);
         assertNotNull(context);
         assertNotNull(state);
 
-        calledForText.append("...\n").append(text);
+        calledForText.append("...\n").append(uncommentedText);
 
-        final String indent = context.isPreserveIndents() ? " ".repeat(firstLineIndent) : "";
+        final String indent = context.isPreserveIndents() ? " ".repeat(recommendedIndent) : "";
 
-        return Arrays.stream(text.split("\\R"))
+        return Arrays.stream(uncommentedText.split("\\R"))
             .map(x -> indent + x)
             .collect(Collectors.joining(context.getEol(), "", context.getEol()));
       }

jcp/src/test/java/com/igormaznitsa/jcp/directives/SpecialDirectivesTest.java

@@ -60,19 +60,19 @@ public void onContextStopped(PreprocessorContext context, Throwable error) {
       }
 
       @Override
-      public String onUncommentText(int firstLineIndent, String text,
-                                    FilePositionInfo filePositionInfo,
-                                    FileInfoContainer fileInfoContainer,
-                                    PreprocessorContext context, PreprocessingState state) {
-        assertTrue(filePositionInfo.getLineNumber() >= 0);
-        assertNotNull(text);
-        assertNotNull(fileInfoContainer);
+      public String processUncommentedText(int recommendedIndent, String uncommentedText,
+                                           FileInfoContainer fileContainer,
+                                           FilePositionInfo positionInfo,
+                                           PreprocessorContext context, PreprocessingState state) {
+        assertTrue(positionInfo.getLineNumber() >= 0);
+        assertNotNull(uncommentedText);
+        assertNotNull(fileContainer);
         assertNotNull(context);
         assertNotNull(state);
 
-        calledForText.append("...\n").append(text);
+        calledForText.append("...\n").append(uncommentedText);
 
-        return text;
+        return uncommentedText;
       }
     };