com.electronwill.nightconfig.core.io

Class IoUtils

java.lang.Object

com.electronwill.nightconfig.core.io.IoUtils

public final class IoUtils
extends java.lang.Object

IO utilities for INTERNAL use only (do not use oustide of night-config).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IoUtils.IoRunnable Like Runnable, but with a throwable IOException.
static class	IoUtils.RetryFailedException

Constructor Summary

Constructors

Constructor and Description
IoUtils()

Method Summary

Modifier and Type	Method and Description
static void	retryIfAccessDenied(java.lang.String name, IoUtils.IoRunnable r) Run an IO operation and retry it (at most maxRetries retries) if it fails with AccessDeniedException.
static void	retryIfAccessDenied(java.lang.String name, IoUtils.IoRunnable r, int maxRetries, long retryDelay, java.util.concurrent.TimeUnit delayUnit)
static java.lang.String	tempConfigFileName(java.nio.file.Path originalFile) Generates a filename (not path) for a temporary config file, for use with WritingMode.REPLACE_ATOMIC.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IoUtils

public IoUtils()

Method Detail

tempConfigFileName

public static java.lang.String tempConfigFileName(java.nio.file.Path originalFile)

Generates a filename (not path) for a temporary config file, for use with WritingMode.REPLACE_ATOMIC. Tries to keep the extension of the original file, to make it easier to find config files and to add them to file scanning whitelist (see the issue related to Windows Defender locking config files).

Parameters:

originalFile - the original config file

Returns:

a filename for the temporary file (the file is not created by this method)

retryIfAccessDenied

public static void retryIfAccessDenied(java.lang.String name,
                                       IoUtils.IoRunnable r)
                                throws java.io.IOException

Run an IO operation and retry it (at most maxRetries retries) if it fails with AccessDeniedException. See https://github.com/TheElectronWill/night-config/issues/183.

Parameters:

name - a name to print in error messages

r - the operation to run

Throws:

java.io.IOException - if it fails after retrying too many times, or for an error other than AccessDeniedException

retryIfAccessDenied

public static void retryIfAccessDenied(java.lang.String name,
                                       IoUtils.IoRunnable r,
                                       int maxRetries,
                                       long retryDelay,
                                       java.util.concurrent.TimeUnit delayUnit)
                                throws java.io.IOException

Throws:

java.io.IOException