Package com.azure.core.util.io

Class IOUtils

java.lang.Object

com.azure.core.util.io.IOUtils

public final class IOUtils
extends Object

Utilities related to IO operations that involve channels, streams, byte transfers.

Method Summary

Modifier and Type	Method	Description
static AsynchronousByteChannel	toAsynchronousByteChannel(AsynchronousFileChannel fileChannel, long position)	Adapts AsynchronousFileChannel to AsynchronousByteChannel.
static void	transfer(ReadableByteChannel source, WritableByteChannel destination)	Transfers bytes from ReadableByteChannel to WritableByteChannel.
static void	transfer(ReadableByteChannel source, WritableByteChannel destination, Long estimatedSourceSize)	Transfers bytes from ReadableByteChannel to WritableByteChannel.
static Mono<Void>	transferAsync(ReadableByteChannel source, AsynchronousByteChannel destination)	Transfers bytes from ReadableByteChannel to AsynchronousByteChannel.
static Mono<Void>	transferAsync(ReadableByteChannel source, AsynchronousByteChannel destination, Long estimatedSourceSize)	Transfers bytes from ReadableByteChannel to AsynchronousByteChannel.
static Mono<Void>	transferStreamResponseToAsynchronousByteChannel(AsynchronousByteChannel targetChannel, StreamResponse sourceResponse, BiFunction<Throwable,Long,Mono<StreamResponse>> onErrorResume, ProgressReporter progressReporter, int maxRetries)	Transfers the StreamResponse content to AsynchronousByteChannel.

Methods inherited from class java.lang.Object

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

Method Details

toAsynchronousByteChannel

public static AsynchronousByteChannel toAsynchronousByteChannel(AsynchronousFileChannel fileChannel,
 long position)

Adapts AsynchronousFileChannel to AsynchronousByteChannel.

Parameters:

fileChannel - The AsynchronousFileChannel.

position - The position in the file to begin writing or reading the content.

Returns:

A AsynchronousByteChannel that delegates to fileChannel.

Throws:

NullPointerException - When fileChannel is null.

IllegalArgumentException - When position is negative.

transfer

public static void transfer(ReadableByteChannel source,
 WritableByteChannel destination)
                     throws IOException

Transfers bytes from ReadableByteChannel to WritableByteChannel.

Parameters:

source - A source ReadableByteChannel.

destination - A destination WritableByteChannel.

Throws:

IOException - When I/O operation fails.

NullPointerException - When source or destination is null.

transfer

public static void transfer(ReadableByteChannel source,
 WritableByteChannel destination,
 Long estimatedSourceSize)
                     throws IOException

Transfers bytes from ReadableByteChannel to WritableByteChannel.

Parameters:

source - A source ReadableByteChannel.

destination - A destination WritableByteChannel.

estimatedSourceSize - An estimated size of the source channel, may be null. Used to better determine the size of the buffer used to transfer data in an attempt to reduce read and write calls.

Throws:

IOException - When I/O operation fails.

NullPointerException - When source or destination is null.

transferAsync

public static Mono<Void> transferAsync(ReadableByteChannel source,
 AsynchronousByteChannel destination)

Transfers bytes from ReadableByteChannel to AsynchronousByteChannel.

Parameters:

source - A source ReadableByteChannel.

destination - A destination AsynchronousByteChannel.

Returns:

A Mono that completes when transfer is finished.

Throws:

NullPointerException - When source or destination is null.

transferAsync

public static Mono<Void> transferAsync(ReadableByteChannel source,
 AsynchronousByteChannel destination,
 Long estimatedSourceSize)

Transfers bytes from ReadableByteChannel to AsynchronousByteChannel.

Parameters:

source - A source ReadableByteChannel.

destination - A destination AsynchronousByteChannel.

estimatedSourceSize - An estimated size of the source channel, may be null. Used to better determine the size of the buffer used to transfer data in an attempt to reduce read and write calls.

Returns:

A Mono that completes when transfer is finished.

Throws:

NullPointerException - When source or destination is null.

transferStreamResponseToAsynchronousByteChannel

public static Mono<Void> transferStreamResponseToAsynchronousByteChannel(AsynchronousByteChannel targetChannel,
 StreamResponse sourceResponse,
 BiFunction<Throwable,Long,Mono<StreamResponse>> onErrorResume,
 ProgressReporter progressReporter,
 int maxRetries)

Transfers the StreamResponse content to AsynchronousByteChannel. Resumes the transfer in case of errors.

Parameters:

targetChannel - The destination AsynchronousByteChannel.

sourceResponse - The initial StreamResponse.

onErrorResume - A BiFunction of Throwable and Long which is used to resume downloading when an error occurs. The function accepts a Throwable and offset at the destination from beginning of writing at which the error occurred.

progressReporter - The ProgressReporter.

maxRetries - The maximum number of times a download can be resumed when an error occurs.

Returns:

A Mono which completion indicates successful transfer.