Class IOUtils
Closeables.- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic <T> voidapplyToAll(Collection<T> collection, IOConsumer<T> consumer) Applies the consumer to all non-null elements in the collection even if an exception is thrown.static voidCloses all givenCloseables.static voidCloses all givenCloseables.static voidcloseWhileHandlingException(Closeable... objects) Closes all givenCloseables, suppressing all thrown exceptions.static voidcloseWhileHandlingException(Iterable<? extends Closeable> objects) Closes all givenCloseables, suppressing all thrown nonErrorexceptions.static voiddeleteFiles(Directory dir, Collection<String> names) Deletes all given file names.static voiddeleteFilesIfExist(Path... files) Deletes all givenPaths, if they exist.static voiddeleteFilesIfExist(Collection<? extends Path> files) Deletes all givenPaths, if they exist.static voiddeleteFilesIgnoringExceptions(Path... files) Deletes all given files, suppressing all thrown IOExceptions.static voiddeleteFilesIgnoringExceptions(Collection<? extends Path> files) Deletes all given files, suppressing all thrown IOExceptions.static voiddeleteFilesIgnoringExceptions(Directory dir, String... files) static voiddeleteFilesIgnoringExceptions(Directory dir, Collection<String> files) Deletes all given files, suppressing all thrown IOExceptions.static voidEnsure that any writes to the given file is written to the storage device that contains it.static ReadergetDecodingReader(InputStream stream, Charset charSet) Wrapping the givenInputStreamin a reader using aCharsetDecoder.static <T> TrequireResourceNonNull(T resource, String name) Wrap all calls toClass.getResource(String)orClass.getResourceAsStream(String)using this method to enforce existence of the resource.static ErrorThis utility method takes a previously caught (non-null)Throwableand rethrows either the original argument if it was a subclass of theIOExceptionor anRuntimeExceptionwith the cause set to the argument.static voidDeletes one or more files or directories (and everything underneath it).static <T extends Throwable>
TuseOrSuppress(T first, T second) Returns the second throwable if the first is null otherwise adds the second as suppressed to the first and returns it.
-
Field Details
-
UTF_8
UTF-8 charset string.Where possible, use
StandardCharsets.UTF_8instead, as using the String constant may slow things down.- See Also:
-
-
Method Details
-
close
Closes all givenCloseables. Some of theCloseables may be null; they are ignored. After everything is closed, the method either throws the first exception it hit while closing, or completes normally if there were no exceptions.- Parameters:
objects- objects to callclose()on- Throws:
IOException
-
close
Closes all givenCloseables.- Throws:
IOException- See Also:
-
closeWhileHandlingException
Closes all givenCloseables, suppressing all thrown exceptions. Some of theCloseables may be null, they are ignored.- Parameters:
objects- objects to callclose()on
-
closeWhileHandlingException
Closes all givenCloseables, suppressing all thrown nonErrorexceptions. Even if aErroris thrown all given closeable are closed.- See Also:
-
getDecodingReader
Wrapping the givenInputStreamin a reader using aCharsetDecoder. Unlike Java's defaults this reader will throw an exception if your it detects the read charset doesn't match the expectedCharset.Decoding readers are useful to load configuration files, stopword lists or synonym files to detect character set problems. However, it's not recommended to use as a common purpose reader.
- Parameters:
stream- the stream to wrap in a readercharSet- the expected charset- Returns:
- a wrapping reader
-
requireResourceNonNull
Wrap all calls toClass.getResource(String)orClass.getResourceAsStream(String)using this method to enforce existence of the resource. This code works around those methods returningnullto signal non-existence.- Parameters:
resource- return value of above methodsname- of resource- Returns:
- the resource passed in if existent
- Throws:
FileNotFoundException- if resource was not foundIOException
-
deleteFilesIgnoringExceptions
Deletes all given files, suppressing all thrown IOExceptions.Note that the files should not be null.
-
deleteFilesIgnoringExceptions
-
deleteFiles
Deletes all given file names. Some of the file names may be null; they are ignored. After everything is deleted, the method either throws the first exception it hit while deleting, or completes normally if there were no exceptions.- Parameters:
dir- Directory to delete files fromnames- file names to delete- Throws:
IOException
-
deleteFilesIgnoringExceptions
Deletes all given files, suppressing all thrown IOExceptions.Some of the files may be null, if so they are ignored.
-
deleteFilesIgnoringExceptions
Deletes all given files, suppressing all thrown IOExceptions.Some of the files may be null, if so they are ignored.
-
deleteFilesIfExist
Deletes all givenPaths, if they exist. Some of theFiles may be null; they are ignored. After everything is deleted, the method either throws the first exception it hit while deleting, or completes normally if there were no exceptions.- Parameters:
files- files to delete- Throws:
IOException
-
deleteFilesIfExist
Deletes all givenPaths, if they exist. Some of theFiles may be null; they are ignored. After everything is deleted, the method either throws the first exception it hit while deleting, or completes normally if there were no exceptions.- Parameters:
files- files to delete- Throws:
IOException
-
rm
Deletes one or more files or directories (and everything underneath it).- Throws:
IOException- if any of the given files (or their subhierarchy files in case of directories) cannot be removed.
-
rethrowAlways
This utility method takes a previously caught (non-null)Throwableand rethrows either the original argument if it was a subclass of theIOExceptionor anRuntimeExceptionwith the cause set to the argument.This method never returns any value, even though it declares a return value of type
Error. The return value declaration is very useful to let the compiler know that the code path following the invocation of this method is unreachable. So in most cases the invocation of this method will be guarded by anifand used together with athrowstatement, as in:if (t != null) throw IOUtils.rethrowAlways(t)- Parameters:
th- The throwable to rethrow, must not be null.- Returns:
- This method always results in an exception, it never returns any value. See method documentation for details and usage example.
- Throws:
IOException- if the argument was an instance of IOExceptionRuntimeException- with theThrowable.getCause()set to the argument, if it was not an instance of IOException.
-
fsync
Ensure that any writes to the given file is written to the storage device that contains it.- Parameters:
fileToSync- the file to fsyncisDir- if true, the given file is a directory (we open for read and ignore IOExceptions, because not all file systems and operating systems allow to fsync on a directory)- Throws:
IOException
-
useOrSuppress
Returns the second throwable if the first is null otherwise adds the second as suppressed to the first and returns it. -
applyToAll
public static <T> void applyToAll(Collection<T> collection, IOConsumer<T> consumer) throws IOException Applies the consumer to all non-null elements in the collection even if an exception is thrown. The first exception thrown by the consumer is re-thrown and subsequent exceptions are suppressed.- Throws:
IOException
-