one.microstream.io.XIO

public final class XIO
extends Object

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class XIO.unchecked

Method Summary

Modifier and Type	Method	Description
`static String`	`addFileSuffix(String fileName, String fileSuffix)`
`static long`	`appendAll(FileChannel fileChannel, ByteBuffer[] byteBuffers)`	Sets the passed `FileChannel`'s position to its current length and repeatedly calls `FileChannel.write(ByteBuffer[])` until the last non-empty buffer has no remaining bytes. This is necessary because JDK's `FileChannel.write(ByteBuffer[])` seems to arbitrarily stop processing the passed `ByteBuffer`s even though they have remaining bytes left to be written.
`static long`	`appendAllGuaranteed(FileChannel fileChannel, ByteBuffer[] byteBuffers)`	Calls `appendAll(FileChannel, ByteBuffer[])`, then `FileChannel.force(boolean)`, then validates if the actual new file size is really exactely what it should be based on old file size and the amount of bytes written.
`static VarString`	`assemblePath(VarString vs, CharSequence... elements)`
`static String`	`buildFilePath(String... items)`
`static <C extends Closeable> C`	`close(C closable, Throwable suppressed)`
`static long`	`copyFile(FileChannel sourceChannel, long sourcePosition, long length, FileChannel targetChannel)`
`static long`	`copyFile(FileChannel sourceChannel, long sourcePosition, FileChannel targetChannel)`
`static long`	`copyFile(FileChannel sourceChannel, FileChannel targetChannel)`	Alias for `targetChannel.transferFrom(sourceChannel, 0, sourceChannel.size())`.
`static long`	`copyFile(FileChannel sourceChannel, FileChannel targetChannel, long targetPosition)`	Uses the sourceChannel's current position!
`static long`	`copyFile(FileChannel sourceChannel, FileChannel targetChannel, long targetPosition, long length)`
`static long`	`copyFile(Path sourceFile, Path targetFile, OpenOption... targetChannelOpenOptions)`	Uses `openFileChannelReading(Path)`, `openFileChannelWriting(Path, OpenOption...)` and `copyFile(FileChannel, FileChannel)` to copy the contents of the specified `sourceFile` to the specified `targetFile`. `ensureDirectoryAndFile(Path)` is intentionally NOT called in order to not swallow problems in the calling context's logic.
`static boolean`	`delete(Path path)`
`static ByteBuffer`	`determineLastNonEmpty(ByteBuffer[] byteBuffers)`
`static <P extends Path> P`	`ensureDirectory(P directory)`
`static <P extends Path> P`	`ensureDirectoryAndFile(P file)`
`static <P extends Path> P`	`ensureFile(P file)`
`static String`	`ensureNormalizedPathSeperators(String path)`
`static String`	`ensureTrailingSlash(String path)`
`static <P extends Path> P`	`ensureWriteableFile(P file)`
`static boolean`	`exists(Path path)`
`static char`	`filePathSeparator()`
`static char`	`fileSuffixSeparator()`
`static String`	`getFileName(Path file)`
`static String`	`getFilePath(Path file)`
`static String`	`getFilePrefix(String fileName)`
`static String`	`getFilePrefix(Path file)`
`static String`	`getFileSuffix(String fileName)`
`static String`	`getFileSuffix(Path file)`
`static boolean`	`hasNoFiles(Path directory)`
`static boolean`	`isDirectory(Path path)`
`static <C extends Consumer<? super Path>> C`	`iterateEntries(Path directory, C logic)`	Warning: this (because of using Files.newDirectoryStream) does some weird file opening/locking stuff.
`static <C extends Consumer<? super Path>> C`	`iterateEntries(Path directory, C logic, Predicate<? super Path> selector)`	Warning: this (because of using Files.newDirectoryStream) does some weird file opening/locking stuff.
`static long`	`lastModified(Path file)`
`static Path[]`	`listEntries(Path directory)`
`static <C extends Consumer<? super Path>> C`	`listEntries(Path directory, C target)`
`static <C extends Consumer<? super Path>> C`	`listEntries(Path directory, C target, Predicate<? super Path> selector)`
`static Path[]`	`listEntries(Path directory, Predicate<? super Path> selector)`
`static void`	`mergeBinary(Iterable<Path> sourceFiles, Path targetFile)`
`static void`	`mergeBinary(Iterable<Path> sourceFiles, Path targetFile, Predicate<? super Path> selector)`
`static void`	`move(Path sourceFile, Path targetFile)`
`static FileChannel`	`openFileChannel(Path file, OpenOption... options)`
`static FileChannel`	`openFileChannelReading(Path file)`
`static FileChannel`	`openFileChannelReading(Path file, OpenOption... options)`
`static FileChannel`	`openFileChannelRW(Path file)`
`static FileChannel`	`openFileChannelRW(Path file, OpenOption... options)`
`static FileChannel`	`openFileChannelWriting(Path file)`
`static FileChannel`	`openFileChannelWriting(Path file, OpenOption... options)`
`static Path`	`Path(String path)`
`static Path`	`Path(String... items)`
`static Path`	`Path(FileSystem fileSystem, String path)`
`static Path`	`Path(FileSystem fileSystem, String... items)`
`static Path`	`Path(Path parent, String... items)`	Creates a sub-path under the passed `parent` `Path` inside the same `FileSystem`.
`static <T> T`	`performClosingOperation(FileChannel fileChannel, IoOperationSR<FileChannel,T> operation)`
`static ByteBuffer`	`read(FileChannel fileChannel)`
`static ByteBuffer`	`read(FileChannel fileChannel, long filePosition)`
`static ByteBuffer`	`read(FileChannel fileChannel, long filePosition, long length)`
`static long`	`read(FileChannel fileChannel, ByteBuffer targetBuffer)`
`static long`	`read(FileChannel fileChannel, ByteBuffer targetBuffer, long filePosition)`
`static long`	`read(FileChannel fileChannel, ByteBuffer targetBuffer, long filePosition, long length)`
`static ByteBuffer`	`read(Path file)`
`static byte[]`	`read_bytes(FileChannel fileChannel)`
`static byte[]`	`read_bytes(Path file)`
`static <T> T`	`readOneShot(Path file, IoOperationSR<FileChannel,T> operation)`
`static String`	`readString(String filePath)`	Extreme convenience method.
`static String`	`readString(String filePath, Charset charSet)`	Extreme convenience method.
`static String`	`readString(FileChannel fileChannel)`
`static String`	`readString(FileChannel fileChannel, Charset charSet)`
`static String`	`readString(Path file)`
`static String`	`readString(Path file, Charset charSet)`
`static long`	`size(Path file)`
`static String[]`	`splitPath(Path path)`
`static String`	`toAbsoluteNormalizedPath(Path file)`
`static void`	`truncate(FileChannel fileChannel, long newSize)`
`static void`	`truncate(Path file, long newSize)`	Truncates the file to the given size
`static void`	`unchecked(IoOperation operation)`
`static <T> T`	`unchecked(IoOperationR<T> operation)`
`static <S> void`	`unchecked(IoOperationS<S> operation, S subject)`
`static <S, R> R`	`unchecked(IoOperationSR<S,R> operation, S subject)`
`static ByteBuffer`	`wrapInDirectByteBuffer(byte[] bytes)`
`static long`	`write(FileChannel fileChannel, Iterable<? extends ByteBuffer> buffers)`
`static long`	`write(FileChannel fileChannel, ByteBuffer buffer)`
`static long`	`write(Path file, byte[] bytes)`	Writes the contents of the array to the file.
`static long`	`write(Path file, String string)`	Writes the contents of the string to the file.
`static long`	`write(Path file, String string, Charset charset)`	Writes the contents of the string to the file.
`static long`	`write(Path file, ByteBuffer buffer)`	Writes the contents of the buffer to the file.
`static long`	`writeAppending(FileChannel fileChannel, ByteBuffer buffer)`
`static long`	`writeAppending(Path file, byte[] bytes)`
`static long`	`writeAppending(Path file, String string)`
`static long`	`writeAppending(Path file, String string, Charset charset)`
`static long`	`writeAppending(Path file, ByteBuffer buffer)`
`static <T> T`	`writeOneShot(Path file, IoOperationSR<FileChannel,T> operation)`
`static long`	`writePositioned(FileChannel fileChannel, long filePosition, ByteBuffer buffer)`
`static long`	`writePositioned(Path file, long filePosition, byte[] bytes)`
`static long`	`writePositioned(Path file, long filePosition, String string)`
`static long`	`writePositioned(Path file, long filePosition, String string, Charset charset)`
`static long`	`writePositioned(Path file, long filePosition, ByteBuffer buffer)`

Methods inherited from class java.lang.Object

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

Method Details
- fileSuffixSeparator
  
  public static char fileSuffixSeparator()
- filePathSeparator
  
  public static char filePathSeparator()
- addFileSuffix
  
  public static String addFileSuffix(String fileName, String fileSuffix)
- getFileSuffix
  
  public static String getFileSuffix(Path file)
- getFileSuffix
  
  public static String getFileSuffix(String fileName)
- getFilePrefix
  
  public static String getFilePrefix(Path file)
- getFilePrefix
  
  public static String getFilePrefix(String fileName)
- unchecked
  
  public static void unchecked(IoOperation operation) throws IORuntimeException
  
  Throws:
  
  IORuntimeException
- unchecked
  
  public static <T> T unchecked(IoOperationR<T> operation) throws IORuntimeException
  
  Throws:
  
  IORuntimeException
- unchecked
  
  public static <S> void unchecked(IoOperationS<S> operation, S subject) throws IORuntimeException
  
  Throws:
  
  IORuntimeException
- unchecked
  
  public static <S, R> R unchecked(IoOperationSR<S,R> operation, S subject) throws IORuntimeException
  
  Throws:
  
  IORuntimeException
- close
  
  public static final <C extends Closeable> C close(C closable, Throwable suppressed) throws IOException
  
  Throws:
  
  IOException
- close
  
  public static final <C extends AutoCloseable> C close(C closable, Throwable suppressed) throws Exception
  
  Throws:
  
  Exception
- ensureNormalizedPathSeperators
  
  public static final String ensureNormalizedPathSeperators(String path)
- ensureTrailingSlash
  
  public static final String ensureTrailingSlash(String path)
- buildFilePath
  
  public static final String buildFilePath(String... items)
- Path
  
  public static final Path Path(String path)
- Path
  
  public static final Path Path(FileSystem fileSystem, String path)
- Path
  
  public static final Path Path(String... items)
- Path
  
  public static final Path Path(FileSystem fileSystem, String... items)
- Path
  
  public static final Path Path(Path parent, String... items)
  
  Creates a sub-path under the passed parent Path inside the same FileSystem.
  Note that this is fundamentally different to Path(String...) or Paths.get(String, String...) since those two end up using FileSystems.getDefault(), no matter the FileSystem that the passed parent Path is associated with.
  
  Parameters:
  
  parent - the parent Path of the new sub-path.
  
  items - the path items defining the sub-path under the passed parent Path.
  
  Returns:
  
  a sub-path under the passed parent Path.
- getFilePath
  
  public static String getFilePath(Path file)
- getFileName
  
  public static String getFileName(Path file)
- splitPath
  
  public static String[] splitPath(Path path)
- assemblePath
  
  public static final VarString assemblePath(VarString vs, CharSequence... elements)
- isDirectory
  
  public static boolean isDirectory(Path path) throws IOException
  
  Throws:
  
  IOException
- exists
  
  public static boolean exists(Path path) throws IOException
  
  Throws:
  
  IOException
- size
  
  public static long size(Path file) throws IOException
  
  Throws:
  
  IOException
- delete
  
  public static final boolean delete(Path path) throws IOException
  
  Throws:
  
  IOException
- listEntries
  
  public static Path[] listEntries(Path directory) throws IOException
  
  Throws:
  
  IOException
- listEntries
  
  public static Path[] listEntries(Path directory, Predicate<? super Path> selector) throws IOException
  
  Throws:
  
  IOException
- listEntries
  
  public static <C extends Consumer<? super Path>> C listEntries(Path directory, C target) throws IOException
  
  Throws:
  
  IOException
- listEntries
  
  public static <C extends Consumer<? super Path>> C listEntries(Path directory, C target, Predicate<? super Path> selector) throws IOException
  
  Throws:
  
  IOException
- iterateEntries
  
  public static <C extends Consumer<? super Path>> C iterateEntries(Path directory, C logic) throws IOException
  
  Warning: this (because of using Files.newDirectoryStream) does some weird file opening/locking stuff.
  Also see: https://stackoverflow.com/questions/48311252/a-bit-strange-behaviour-of-files-delete-and-files-deleteifexists
  
  Type Parameters:
  
  C - the consumer type
  
  Parameters:
  
  directory - the directory to iterate
  
  logic - the itaration logic
  
  Returns:
  
  the given logic
  
  Throws:
  
  IOException - if an IO error occurs
- iterateEntries
  
  public static <C extends Consumer<? super Path>> C iterateEntries(Path directory, C logic, Predicate<? super Path> selector) throws IOException
  
  Warning: this (because of using Files.newDirectoryStream) does some weird file opening/locking stuff.
  Also see: https://stackoverflow.com/questions/48311252/a-bit-strange-behaviour-of-files-delete-and-files-deleteifexists
  
  Type Parameters:
  
  C - the consumer type
  
  Parameters:
  
  directory - the directory to iterate
  
  logic - the itaration logic
  
  selector - filter predicate
  
  Returns:
  
  the given logic
  
  Throws:
  
  IOException - if an IO error occurs
- hasNoFiles
  
  public static boolean hasNoFiles(Path directory) throws IOException
  
  Throws:
  
  IOException
- lastModified
  
  public static final long lastModified(Path file) throws IOException
  
  Throws:
  
  IOException
- toAbsoluteNormalizedPath
  
  public static String toAbsoluteNormalizedPath(Path file)
- ensureDirectory
  
  public static final <P extends Path> P ensureDirectory(P directory) throws IOException
  
  Throws:
  
  IOException
- ensureDirectoryAndFile
  
  public static final <P extends Path> P ensureDirectoryAndFile(P file) throws IOException
  
  Throws:
  
  IOException
- ensureFile
  
  public static final <P extends Path> P ensureFile(P file) throws IOException
  
  Throws:
  
  IOException
- ensureWriteableFile
  
  public static final <P extends Path> P ensureWriteableFile(P file) throws IOException, FilePathException
  
  Throws:
  
  IOException
  
  FilePathException
- openFileChannelReading
  
  public static FileChannel openFileChannelReading(Path file) throws IOException
  
  Throws:
  
  IOException
- openFileChannelWriting
  
  public static FileChannel openFileChannelWriting(Path file) throws IOException
  
  Throws:
  
  IOException
- openFileChannelRW
  
  public static FileChannel openFileChannelRW(Path file) throws IOException
  
  Throws:
  
  IOException
- openFileChannelReading
  
  public static FileChannel openFileChannelReading(Path file, OpenOption... options) throws IOException
  
  Throws:
  
  IOException
- openFileChannelWriting
  
  public static FileChannel openFileChannelWriting(Path file, OpenOption... options) throws IOException
  
  Throws:
  
  IOException
- openFileChannelRW
  
  public static FileChannel openFileChannelRW(Path file, OpenOption... options) throws IOException
  
  Throws:
  
  IOException
- openFileChannel
  
  public static FileChannel openFileChannel(Path file, OpenOption... options) throws IOException
  
  Throws:
  
  IOException
- readOneShot
  
  public static final <T> T readOneShot(Path file, IoOperationSR<FileChannel,T> operation) throws IOException
  
  Throws:
  
  IOException
- readString
  
  public static String readString(String filePath) throws IOException
  
  Extreme convenience method. Normally, methods handling files should not accept file path strings, but only properly typed file instances like Path. However, for a convenience method, there is not much safety won writing readString(Path("./my/path/myFile.txt")), only verbosity.
  So when already using a convenience method, anyway, why not make it really convenient and accept file path strings right away?
  
  Parameters:
  
  filePath - the source file path
  
  Returns:
  
  the contents of the file
  
  Throws:
  
  IOException - if an IO error occurs
- readString
  
  public static String readString(String filePath, Charset charSet) throws IOException
  
  Extreme convenience method. Normally, methods handling files should not accept file path strings, but only properly typed file instances like Path. However, for a convenience method, there is not much safety won writing readString(Path("./my/path/myFile.txt")), only verbosity.
  So when already using a convenience method, anyway, why not make it really convienent and accept file path strings right away?
  
  Parameters:
  
  filePath - the source file path
  
  charSet - the charset to use
  
  Returns:
  
  the contents of the file
  
  Throws:
  
  IOException - if an IO error occurs
- readString
  
  public static String readString(Path file) throws IOException
  
  Throws:
  
  IOException
- readString
  
  public static String readString(Path file, Charset charSet) throws IOException
  
  Throws:
  
  IOException
- readString
  
  public static String readString(FileChannel fileChannel) throws IOException
  
  Throws:
  
  IOException
- readString
  
  public static String readString(FileChannel fileChannel, Charset charSet) throws IOException
  
  Throws:
  
  IOException
- read_bytes
  
  public static byte[] read_bytes(Path file) throws IOException
  
  Throws:
  
  IOException
- read_bytes
  
  public static byte[] read_bytes(FileChannel fileChannel) throws IOException
  
  Throws:
  
  IOException
- read
  
  public static ByteBuffer read(Path file) throws IOException
  
  Throws:
  
  IOException
- writeOneShot
  
  public static final <T> T writeOneShot(Path file, IoOperationSR<FileChannel,T> operation) throws IOException
  
  Throws:
  
  IOException
- write
  
  public static final long write(Path file, String string) throws IOException
  
  Writes the contents of the string to the file.
  Attention: Internally this method opens a new FileChannel to operate on!
  
  Parameters:
  
  file - the file to write to
  
  string - the string to write
  
  Returns:
  
  number of actual written bytes
  
  Throws:
  
  IOException - if an IO error occurs
- write
  
  public static final long write(Path file, String string, Charset charset) throws IOException
  
  Writes the contents of the string to the file.
  Attention: Internally this method opens a new FileChannel to operate on!
  
  Parameters:
  
  file - the file to write to
  
  string - the string to write
  
  charset - the charset which is used to decode the string
  
  Returns:
  
  number of actual written bytes
  
  Throws:
  
  IOException - if an IO error occurs
- write
  
  public static final long write(Path file, byte[] bytes) throws IOException
  
  Writes the contents of the array to the file.
  Attention: Internally this method opens a new FileChannel to operate on!
  
  Parameters:
  
  file - the file to write to
  
  bytes - the bytes to write
  
  Returns:
  
  number of actual written bytes
  
  Throws:
  
  IOException - if an IO error occurs
- write
  
  public static long write(Path file, ByteBuffer buffer) throws IOException
  
  Writes the contents of the buffer to the file.
  Attention: Internally this method opens a new FileChannel to operate on!
  
  Parameters:
  
  file - the file to write to
  
  buffer - the buffer to write
  
  Returns:
  
  number of actual written bytes
  
  Throws:
  
  IOException - if an IO error occurs
- truncate
  
  public static void truncate(Path file, long newSize) throws IOException
  
  Truncates the file to the given size
  Attention: Internally this method opens a new FileChannel to operate on!
  
  Parameters:
  
  file - file to be truncated
  
  newSize - new Size, must be zero or greater
  
  Throws:
  
  IOException - if an IO error occurs
- writePositioned
  
  public static final long writePositioned(Path file, long filePosition, String string) throws IOException
  
  Throws:
  
  IOException
- writePositioned
  
  public static final long writePositioned(Path file, long filePosition, String string, Charset charset) throws IOException
  
  Throws:
  
  IOException
- writePositioned
  
  public static final long writePositioned(Path file, long filePosition, byte[] bytes) throws IOException
  
  Throws:
  
  IOException
- writePositioned
  
  public static long writePositioned(Path file, long filePosition, ByteBuffer buffer) throws IOException
  
  Throws:
  
  IOException
- writeAppending
  
  public static final long writeAppending(Path file, String string) throws IOException
  
  Throws:
  
  IOException
- writeAppending
  
  public static final long writeAppending(Path file, String string, Charset charset) throws IOException
  
  Throws:
  
  IOException
- writeAppending
  
  public static final long writeAppending(Path file, byte[] bytes) throws IOException
  
  Throws:
  
  IOException
- writeAppending
  
  public static long writeAppending(Path file, ByteBuffer buffer) throws IOException
  
  Throws:
  
  IOException
- mergeBinary
  
  public static final void mergeBinary(Iterable<Path> sourceFiles, Path targetFile, Predicate<? super Path> selector)
- mergeBinary
  
  public static final void mergeBinary(Iterable<Path> sourceFiles, Path targetFile)
- move
  
  public static void move(Path sourceFile, Path targetFile) throws IOException, RuntimeException
  
  Throws:
  
  IOException
  
  RuntimeException
- determineLastNonEmpty
  
  public static ByteBuffer determineLastNonEmpty(ByteBuffer[] byteBuffers)
- wrapInDirectByteBuffer
  
  public static final ByteBuffer wrapInDirectByteBuffer(byte[] bytes)
- appendAll
  
  public static long appendAll(FileChannel fileChannel, ByteBuffer[] byteBuffers) throws IOException
  
  Sets the passed FileChannel's position to its current length and repeatedly calls FileChannel.write(ByteBuffer[]) until the last non-empty buffer has no remaining bytes.
  This is necessary because JDK's FileChannel.write(ByteBuffer[]) seems to arbitrarily stop processing the passed ByteBuffers even though they have remaining bytes left to be written.
  The reason for this behavior is unknown, but looking at countless other issues in the JDK code, one might guess... .
  
  Parameters:
  
  fileChannel - the target file channel
  
  byteBuffers - the source data buffers
  
  Returns:
  
  the number of written bytes
  
  Throws:
  
  IOException - if an IO error occurs
- appendAllGuaranteed
  
  public static long appendAllGuaranteed(FileChannel fileChannel, ByteBuffer[] byteBuffers) throws IOException
  
  Calls appendAll(FileChannel, ByteBuffer[]), then FileChannel.force(boolean), then validates if the actual new file size is really exactely what it should be based on old file size and the amount of bytes written.
  In short: this method "guarantees" that every byte contained in the passed ByteBuffers was appended to the passed FileChannel and actually reached the physical file.
  
  Parameters:
  
  fileChannel - the target file channel
  
  byteBuffers - the source data buffers
  
  Returns:
  
  the number of written bytes
  
  Throws:
  
  IOException - if an IO error occurs
- writeAppending
  
  public static long writeAppending(FileChannel fileChannel, ByteBuffer buffer) throws IOException
  
  Throws:
  
  IOException
- writePositioned
  
  public static long writePositioned(FileChannel fileChannel, long filePosition, ByteBuffer buffer) throws IOException
  
  Throws:
  
  IOException
- write
  
  public static long write(FileChannel fileChannel, ByteBuffer buffer) throws IOException
  
  Throws:
  
  IOException
- write
  
  public static long write(FileChannel fileChannel, Iterable<? extends ByteBuffer> buffers) throws IOException
  
  Throws:
  
  IOException
- truncate
  
  public static void truncate(FileChannel fileChannel, long newSize) throws IOException
  
  Throws:
  
  IOException
- performClosingOperation
  
  public static final <T> T performClosingOperation(FileChannel fileChannel, IoOperationSR<FileChannel,T> operation) throws IOException
  
  Throws:
  
  IOException
- read
  
  public static ByteBuffer read(FileChannel fileChannel) throws IOException
  
  Throws:
  
  IOException
- read
  
  public static ByteBuffer read(FileChannel fileChannel, long filePosition) throws IOException
  
  Throws:
  
  IOException
- read
  
  public static ByteBuffer read(FileChannel fileChannel, long filePosition, long length) throws IOException
  
  Throws:
  
  IOException
- read
  
  public static long read(FileChannel fileChannel, ByteBuffer targetBuffer) throws IOException
  
  Throws:
  
  IOException
- read
  
  public static long read(FileChannel fileChannel, ByteBuffer targetBuffer, long filePosition, long length) throws IOException
  
  Throws:
  
  IOException
- read
  
  public static long read(FileChannel fileChannel, ByteBuffer targetBuffer, long filePosition) throws IOException
  
  Throws:
  
  IOException
- copyFile
  
  public static long copyFile(Path sourceFile, Path targetFile, OpenOption... targetChannelOpenOptions) throws IOException
  
  Uses openFileChannelReading(Path), openFileChannelWriting(Path, OpenOption...) and copyFile(FileChannel, FileChannel) to copy the contents of the specified sourceFile to the specified targetFile.
  ensureDirectoryAndFile(Path) is intentionally NOT called in order to not swallow problems in the calling context's logic.
  Important note:
  This method is a fix for the JDK method Files.copy(Path, Path, java.nio.file.CopyOption...), which throws an exception about another process having locked "the file" (without specifying which one it means) if the process owns a lock on the source file. Since this means the process locks itself out of using the source file if it has secured the source file for its exclusive use. As a consequence, the JDK method cannot be used if a file is locked and should generally not be trusted.
  For any special needs like copying from and/or to a position and/or only a part of the file and/or using custom OpenOptions and/or modifying file timestamps and or performing pre- or post-actions, it is strongly suggested to write a custom tailored version of a copying method. Covering all conceivable cases would result in an overly complicated one-size-fits-all attempt and we all know how well those work in practice.
  
  Parameters:
  
  sourceFile - the source file whose content shall be copied.
  
  targetFile - the target file that shall receive the copied content. Must already exist!
  
  targetChannelOpenOptions - the OpenOptions (see StandardOpenOption) to be passed to openFileChannelWriting(Path, OpenOption...). May be null / empty.
  
  Returns:
  
  the number of bytes written by FileChannel.transferFrom(java.nio.channels.ReadableByteChannel, long, long).
  
  Throws:
  
  IOException - if an IO error occurs
  
  See Also:
  
  ensureFile(Path), ensureDirectoryAndFile(Path), StandardOpenOption, openFileChannelReading(Path), openFileChannelWriting(Path), copyFile(FileChannel, FileChannel), FileChannel.transferFrom(java.nio.channels.ReadableByteChannel, long, long)
- copyFile
  
  public static long copyFile(FileChannel sourceChannel, FileChannel targetChannel) throws IOException
  
  Alias for targetChannel.transferFrom(sourceChannel, 0, sourceChannel.size()).
  
  Parameters:
  
  sourceChannel - an open and readable channel to the source file whose content shall be copied.
  
  targetChannel - an open and writeable channel to the target file that shall receive the copied content.
  
  Returns:
  
  The number of bytes, possibly zero, that were actually transferred.
  
  Throws:
  
  IOException - as specified by FileChannel.transferFrom(java.nio.channels.ReadableByteChannel, long, long)
  
  See Also:
  
  FileChannel.transferFrom(java.nio.channels.ReadableByteChannel, long, long), copyFile(Path, Path, OpenOption...)
- copyFile
  
  public static long copyFile(FileChannel sourceChannel, FileChannel targetChannel, long targetPosition) throws IOException
  
  Uses the sourceChannel's current position!
  
  Parameters:
  
  sourceChannel - an open and readable channel to the source file whose content shall be copied.
  
  targetChannel - an open and writeable channel to the target file that shall receive the copied content.
  
  targetPosition - the position to write to in the target channel
  
  Returns:
  
  the number of written bytes
  
  Throws:
  
  IOException - as specified by FileChannel.transferFrom(java.nio.channels.ReadableByteChannel, long, long)
- copyFile
  
  public static long copyFile(FileChannel sourceChannel, long sourcePosition, FileChannel targetChannel) throws IOException
  
  Throws:
  
  IOException
- copyFile
  
  public static long copyFile(FileChannel sourceChannel, long sourcePosition, long length, FileChannel targetChannel) throws IOException
  
  Throws:
  
  IOException
- copyFile
  
  public static long copyFile(FileChannel sourceChannel, FileChannel targetChannel, long targetPosition, long length) throws IOException
  
  Throws:
  
  IOException

Class XIO

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Details