Clarify

Author: AB-xdev

CHANGELOG.md

@@ -1,5 +1,5 @@
 # 2.2.0
-* Added an explicit option for enabling the Windows NTFS junction fix: ``withUseWinNTFSJunctionFix`` #155
+* Added an explicit option for enabling the Windows NTFS junction fix: ``useWinNTFSJunctionFixIfApplicable`` #155
   * Enabling it also requires adding ``--add-exports java.base/sun.nio.fs=ALL-UNNAMED`` or performance will be impacted by 100x due to non-accessible file attributes cache
   * This option is temporary and will be removed once the underlying JDK bug was fixed
 * The default logger of ``AdvancedImageFromDockerFile`` now also includes ``dockerImageName`` to make it easier to distinguish between parallel builds

testcontainers-advanced-imagebuilder/src/main/java/software/xdev/testcontainers/imagebuilder/AdvancedImageFromDockerFile.java

@@ -121,7 +121,7 @@ public class AdvancedImageFromDockerFile
 	protected Optional<String> target = Optional.empty();
 	protected final Set<Consumer<BuildImageCmd>> buildImageCmdModifiers = new LinkedHashSet<>();
 	protected Set<String> externalDependencyImageNames = Collections.emptySet();
-	protected boolean useWinNTFSJunctionFix;
+	protected boolean useWinNTFSJunctionFixIfApplicable;
 
 	@SuppressWarnings("checkstyle:MagicNumber")
 	public AdvancedImageFromDockerFile()
@@ -366,7 +366,7 @@ protected void configure(final BuildImageCmd buildImageCmd)
 				this.ignoreFileLineFilter,
 				this.postGitIgnoreLines,
 				alwaysIncludePaths,
-				this.useWinNTFSJunctionFix);
+				this.useWinNTFSJunctionFixIfApplicable);
 
 			this.log().info(
 				"{}x files will be transferred (determination took {}ms)",
@@ -612,14 +612,14 @@ public AdvancedImageFromDockerFile withBuildImageCmdModifier(final Consumer<Buil
 	}
 
 	/**
-	 * Should the fix for a crash when encountering Windows NTFS Junctions be applied?
+	 * Should the fix for a crash when encountering Windows NTFS Junctions be applied if applicable?
 	 * <p>
 	 * See {@link software.xdev.testcontainers.imagebuilder.transfer.java.nio.file.winntfs} for details
 	 * </p>
 	 */
-	public AdvancedImageFromDockerFile withUseWinNTFSJunctionFix(final boolean useWinNTFSJunctionFix)
+	public AdvancedImageFromDockerFile withUseWinNTFSJunctionFixIfApplicable(final boolean useWinNTFSJunctionFixIfApplicable)
 	{
-		this.useWinNTFSJunctionFix = useWinNTFSJunctionFix;
+		this.useWinNTFSJunctionFixIfApplicable = useWinNTFSJunctionFixIfApplicable;
 		return this;
 	}
 }

testcontainers-advanced-imagebuilder/src/main/java/software/xdev/testcontainers/imagebuilder/transfer/DefaultTransferFilesCreator.java

@@ -83,7 +83,7 @@ public Map<Path, String> determineFilesToTransfer(
 		final Predicate<String> ignoreFileLineFilter,
 		final Set<String> postGitIgnoreLines,
 		final Set<String> alwaysIncludedRelativePaths,
-		final boolean useWinNTFSJunctionFix)
+		final boolean useWinNTFSJunctionFixIfApplicable)
 	{
 		try
 		{
@@ -102,7 +102,7 @@ public Map<Path, String> determineFilesToTransfer(
 			return this.walkFilesAndDetermineTransfer(
 				ignoreNode,
 				alwaysIncludedRelativePaths,
-				useWinNTFSJunctionFix);
+				useWinNTFSJunctionFixIfApplicable);
 		}
 		catch(final IOException ioe)
 		{
@@ -136,10 +136,10 @@ protected IgnoreNode createIgnoreNode(final Set<String> ignoreLines)
 	protected Map<Path, String> walkFilesAndDetermineTransfer(
 		final IgnoreNode ignoreNode,
 		final Set<String> alwaysIncludedRelativePaths,
-		final boolean useWinNTFSJunctionFix) throws IOException
+		final boolean useWinNTFSJunctionFixIfApplicable) throws IOException
 	{
 		try(final Stream<Path> walk = findFiles(
-			useWinNTFSJunctionFix,
+			useWinNTFSJunctionFixIfApplicable,
 			this.baseDir,
 			Integer.MAX_VALUE,
 			// Ignore directories
@@ -165,14 +165,14 @@ protected Map<Path, String> walkFilesAndDetermineTransfer(
 	}
 
 	protected static Stream<Path> findFiles(
-		final boolean useWinNTFSJunctionFix,
+		final boolean useWinNTFSJunctionFixIfApplicable,
 		final Path start,
 		final int maxDepth,
 		final BiPredicate<Path, BasicFileAttributes> matcher,
 		final FileVisitOption... options)
 		throws IOException
 	{
-		return useWinNTFSJunctionFix && WinNTFSJunctionFiles.shouldBeApplied(start)
+		return useWinNTFSJunctionFixIfApplicable && WinNTFSJunctionFiles.shouldBeApplied(start)
 			? WinNTFSJunctionFiles.find(start, maxDepth, matcher, options)
 			: Files.find(start, maxDepth, matcher, options);
 	}

testcontainers-advanced-imagebuilder/src/main/java/software/xdev/testcontainers/imagebuilder/transfer/TransferFilesCreator.java

@@ -29,7 +29,7 @@ Map<Path, String> determineFilesToTransfer(
 		Predicate<String> ignoreFileLineFilter,
 		Set<String> postGitIgnoreLines,
 		Set<String> alwaysIncludedRelativePaths,
-		boolean useWinNTFSJunctionFix);
+		boolean useWinNTFSJunctionFixIfApplicable);
 
 	InputStream getAllFilesToTransferAsTarInputStream(
 		Map<Path, String> filesToTransfer,