refactoring

Author: raydac

jcp/src/main/java/com/igormaznitsa/jcp/JcpPreprocessor.java

@@ -415,7 +415,7 @@ private void createTargetFolder() throws IOException {
     final boolean targetExists = target.isDirectory();
 
     if (context.isClearTarget() && targetExists) {
-      this.context.logForVerbose("Cleaining target folder: " + target);
+      this.context.logForVerbose("Cleaning target folder: " + target);
       try {
         FileUtils.cleanDirectory(target);
       } catch (IOException ex) {

jcp/src/main/java/com/igormaznitsa/jcp/cmdline/CommandLineHandler.java

@@ -24,7 +24,7 @@
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 
 /**
- * The interface describes a command line key handler. It is not just a handler
+ * The interface describes a command line key handler. It is not just a handler,
  * but it will be called for all met keys to recognize one to be processed.
  *
  * @author Igor Maznitsa (igor.maznitsa@igormaznitsa.com)

jcp/src/main/java/com/igormaznitsa/jcp/cmdline/GlobalVariableHandler.java

@@ -29,7 +29,7 @@
 
 /**
  * The handler for global variables, it adds met global variables into the
- * inside storage
+ * internal storage
  *
  * @author Igor Maznitsa (igor.maznitsa@igormaznitsa.com)
  */

jcp/src/main/java/com/igormaznitsa/jcp/cmdline/RemoveCommentsHandler.java

@@ -25,8 +25,7 @@
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 
 /**
- * The handler processing the flag to clear all sources in the destination
- * directory from inside comments
+ * Processes the flag that clears all source files from the destination directory, stripping them even from within comments.
  *
  * @author Igor Maznitsa (igor.maznitsa@igormaznitsa.com)
  */
@@ -36,7 +35,7 @@ public class RemoveCommentsHandler implements CommandLineHandler {
 
   @Override
   public String getDescription() {
-    return "strip all comments from output files";
+    return "strip all comments in result files";
   }
 
   @Override

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

@@ -23,7 +23,7 @@
 
 import static com.igormaznitsa.jcp.removers.AbstractCommentRemover.makeCommentRemover;
 import static com.igormaznitsa.jcp.utils.IOUtils.closeQuietly;
-import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findFirstActiveFileContainer;
+import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findActiveFileInfoContainer;
 import static java.util.Objects.requireNonNull;
 import static java.util.Objects.requireNonNullElse;
 
@@ -160,16 +160,20 @@ public String getLastReadString() {
     return this.lastReadString;
   }
 
-  public void pushExcludeIfData(final FileInfoContainer infoContainer,
-                                final String excludeIfCondition, final int stringIndex) {
+  public void pushExcludeIfData(
+      final FileInfoContainer infoContainer,
+      final String excludeIfCondition,
+      final int stringIndex
+  ) {
     requireNonNull(infoContainer, "File info is null");
     requireNonNull(excludeIfCondition, "Condition is null");
 
     if (stringIndex < 0) {
       throw new IllegalArgumentException("Unexpected string index [" + stringIndex + ']');
     }
 
-    deferredExcludeStack.push(new ExcludeIfInfo(infoContainer, excludeIfCondition, stringIndex));
+    this.deferredExcludeStack.push(
+        new ExcludeIfInfo(infoContainer, excludeIfCondition, stringIndex));
   }
 
   public ResettablePrinter getSelectedPrinter() {
@@ -296,11 +300,6 @@ public boolean isIncludeStackEmpty() {
     return includeStack.isEmpty();
   }
 
-  public boolean isOnlyRootOnStack() {
-    return includeStack.size() == 1;
-  }
-
-
   private TextFileDataContainer cloneTopTextDataContainer() {
     final TextFileDataContainer topElement = requireNonNull(includeStack.peek());
     return new TextFileDataContainer(topElement,
@@ -553,7 +552,7 @@ public boolean saveBuffersToFile(final File outFile, final CommentRemoverType ke
     }
 
     if (wasSaved) {
-      findFirstActiveFileContainer(context).ifPresent(t -> t.getGeneratedResources().add(outFile));
+      findActiveFileInfoContainer(context).ifPresent(t -> t.getGeneratedResources().add(outFile));
       if (this.context.isKeepAttributes() && outFile.exists()) {
         PreprocessorUtils.copyFileAttributes(this.getRootFileInfo().getSourceFile(), outFile);
       }

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

@@ -506,7 +506,7 @@ public void logWarning(final String text) {
   }
 
   /**
-   * Set a shared source, it is an object saved into the inside map for a name
+   * Set a shared source, it is an object saved into the internal map for a name
    *
    * @param name the name for the saved project, must not be null
    * @param obj  the object to be saved in, must not be null
@@ -519,7 +519,7 @@ public void setSharedResource(final String name, final Object obj) {
   }
 
   /**
-   * Get a shared source from inside map
+   * Get a shared source from internal map
    *
    * @param name the name of the needed object, it must not be null
    * @return a cached object or null if it is not found
@@ -531,7 +531,7 @@ public Object getSharedResource(final String name) {
   }
 
   /**
-   * Remove a shared object from the inside map for its name
+   * Remove a shared object from the internal map for its name
    *
    * @param name the object name, it must not be null
    * @return removing object or null if it is not found
@@ -754,7 +754,7 @@ public boolean containsLocalVariable(final String name) {
   }
 
   /**
-   * Remove all local variables from the inside storage
+   * Remove all local variables from the internal storage
    *
    * @return this preprocessor context
    */
@@ -812,10 +812,10 @@ public PreprocessorContext setGlobalVariable(final String name, final Value valu
   }
 
   /**
-   * Check that there is a named global variable in the inside storage
+   * Check that there is a named global variable in the internal storage
    *
    * @param name the checking name, it will be normalized to the supported format, it can be null
-   * @return true if such variable is presented for its name in the inside storage, otherwise false (also it is false if the name is null)
+   * @return true if such variable is presented for its name in the internal storage, otherwise false (also it is false if the name is null)
    */
   public boolean containsGlobalVariable(final String name) {
     if (name == null) {

jcp/src/main/java/com/igormaznitsa/jcp/directives/ActionDirectiveHandler.java

@@ -83,14 +83,14 @@ public AfterDirectiveProcessingBehaviour execute(final String string,
             null);
       }
 
-      final Value[] results = new Value[args.size()];
+      final Value[] argValues = new Value[args.size()];
       int index = 0;
       for (final ExpressionTree expr : args) {
         final Value val = Expression.evalTree(expr, context);
-        results[index++] = val;
+        argValues[index++] = val;
       }
 
-      if (!extension.processAction(context, results)) {
+      if (!extension.processAction(context, argValues)) {
         throw context.makeException("Unable to process an action", null);
       }
     } catch (IOException ex) {

jcp/src/main/java/com/igormaznitsa/jcp/directives/ExcludeIfDirectiveHandler.java

@@ -21,9 +21,10 @@
 
 package com.igormaznitsa.jcp.directives;
 
+import static java.util.Objects.requireNonNull;
+
 import com.igormaznitsa.jcp.context.PreprocessingState;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
-import java.util.Objects;
 
 /**
  * The class implements the //#excludeif directive handler
@@ -62,7 +63,7 @@ public AfterDirectiveProcessingBehaviour execute(final String string,
                                                    final PreprocessorContext context) {
     final PreprocessingState state = context.getPreprocessingState();
     state.pushExcludeIfData(state.getRootFileInfo(), string,
-        Objects.requireNonNull(state.peekIncludeStackFile(), "'IF' stack is empty!")
+        requireNonNull(state.peekIncludeStackFile(), "'IF' stack is empty!")
             .getLastReadStringIndex());
     return AfterDirectiveProcessingBehaviour.PROCESSED;
   }

jcp/src/main/java/com/igormaznitsa/jcp/directives/FlushDirectiveHandler.java

@@ -21,7 +21,7 @@
 
 package com.igormaznitsa.jcp.directives;
 
-import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findFirstActiveFileContainer;
+import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findActiveFileInfoContainer;
 
 import com.igormaznitsa.jcp.context.PreprocessingState;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
@@ -62,7 +62,7 @@ public AfterDirectiveProcessingBehaviour execute(final String string,
               "Content was " + (saved ? "saved" : "not saved") + " into file '" + outFile + "'");
         }
 
-        findFirstActiveFileContainer(context)
+        findActiveFileInfoContainer(context)
             .ifPresent(f -> f.getGeneratedResources().add(outFile));
 
         state.resetPrinters();

jcp/src/main/java/com/igormaznitsa/jcp/directives/IncludeDirectiveHandler.java

@@ -21,7 +21,7 @@
 
 package com.igormaznitsa.jcp.directives;
 
-import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findFirstActiveFileContainer;
+import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findActiveFileInfoContainer;
 
 import com.igormaznitsa.jcp.context.PreprocessingState;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
@@ -67,7 +67,7 @@ public AfterDirectiveProcessingBehaviour execute(final String string,
       }
       state.openFile(fileToInclude);
 
-      findFirstActiveFileContainer(context)
+      findActiveFileInfoContainer(context)
           .ifPresent(f -> f.getIncludedSources().add(fileToInclude));
     } catch (IOException ex) {
       throw context.makeException("Can't open file '" + filePath + '\'', ex);