Package com.helger.commons.io.stream

Class StreamHelper.CopyByteStreamBuilder

java.lang.Object

com.helger.commons.io.stream.StreamHelper.CopyByteStreamBuilder

All Implemented Interfaces:

IBuilder<ESuccess>

Enclosing class:

StreamHelper

public static class StreamHelper.CopyByteStreamBuilder
extends Object
implements IBuilder<ESuccess>

A simple builder to copy an InputStream (from(InputStream)) to an OutputStream (to(OutputStream)) with certain parameters. Call build() to execute the copying.

Since:

10.0.0

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_CLOSE_DESTINATION
static boolean	DEFAULT_CLOSE_SOURCE

Constructor Summary

Constructors

Constructor	Description
CopyByteStreamBuilder()

Method Summary

Modifier and Type	Method	Description
StreamHelper.CopyByteStreamBuilder	buffer(byte[] a)
ESuccess	build()	This method performs the main copying
StreamHelper.CopyByteStreamBuilder	closeFrom(boolean b)
StreamHelper.CopyByteStreamBuilder	closeTo(boolean b)
StreamHelper.CopyByteStreamBuilder	copyByteCount(MutableLong a)
StreamHelper.CopyByteStreamBuilder	exceptionCallback(IExceptionCallback<IOException> a)
StreamHelper.CopyByteStreamBuilder	from(InputStream a)
StreamHelper.CopyByteStreamBuilder	limit(long n)
StreamHelper.CopyByteStreamBuilder	limit(Long a)
StreamHelper.CopyByteStreamBuilder	progressCallback(LongConsumer a)
StreamHelper.CopyByteStreamBuilder	to(OutputStream a)
StreamHelper.CopyByteStreamBuilder	unlimited()	Ensure no limit in copying (which is also the default).

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CLOSE_SOURCE

public static final boolean DEFAULT_CLOSE_SOURCE

See Also:

Constant Field Values

DEFAULT_CLOSE_DESTINATION

public static final boolean DEFAULT_CLOSE_DESTINATION

See Also:

Constant Field Values

Constructor Detail

CopyByteStreamBuilder

public CopyByteStreamBuilder()

Method Detail

from

@Nonnull
public StreamHelper.CopyByteStreamBuilder from(@Nullable
                                               InputStream a)

Parameters:

a - The InputStream to read from. May be null.

Returns:

this for chaining

closeFrom

@Nonnull
public StreamHelper.CopyByteStreamBuilder closeFrom(boolean b)

Parameters:

b - true to close the InputStream, false to leave it open. Default is DEFAULT_CLOSE_SOURCE

Returns:

this for chaining

to

@Nonnull
public StreamHelper.CopyByteStreamBuilder to(@Nullable
                                             OutputStream a)

Parameters:

a - The OutputStream to write to. May be null.

Returns:

this for chaining

closeTo

@Nonnull
public StreamHelper.CopyByteStreamBuilder closeTo(boolean b)

Parameters:

b - true to close the OutputStream, false to leave it open.

Returns:

this for chaining

buffer

@Nonnull
public StreamHelper.CopyByteStreamBuilder buffer(@Nullable
                                                 byte[] a)

Parameters:

a - The buffer to use. May be null.

Returns:

this for chaining

limit

@Nonnull
public StreamHelper.CopyByteStreamBuilder limit(long n)

Parameters:

n - An optional maximum number of bytes to copied from the InputStream to the OutputStream. May be < 0 to indicate no limit, meaning all bytes are copied.

Returns:

this for chaining

See Also:

unlimited()

limit

@Nonnull
public StreamHelper.CopyByteStreamBuilder limit(@Nullable
                                                Long a)

Parameters:

a - An optional maximum number of bytes to copied from the InputStream to the OutputStream. May be < 0 to indicate no limit, meaning all bytes are copied. If null no limit is set

Returns:

this for chaining

Since:

10.1.0

See Also:

unlimited()

unlimited

@Nonnull
public StreamHelper.CopyByteStreamBuilder unlimited()

Ensure no limit in copying (which is also the default).

Returns:

this for chaining

See Also:

limit(long)

exceptionCallback

@Nonnull
public StreamHelper.CopyByteStreamBuilder exceptionCallback(@Nullable
                                                            IExceptionCallback<IOException> a)

Parameters:

a - The Exception callback to be invoked, if an exception occurs. May be null.

Returns:

this for chaining

copyByteCount

@Nonnull
public StreamHelper.CopyByteStreamBuilder copyByteCount(@Nullable
                                                        MutableLong a)

Parameters:

a - An optional mutable long object that will receive the total number of copied bytes. Note: and optional old value is overwritten. Note: this is only called, if copying was successful, and not in case of an exception.

Returns:

this for chaining

progressCallback

@Nonnull
public StreamHelper.CopyByteStreamBuilder progressCallback(@Nullable
                                                           LongConsumer a)

Parameters:

a - An optional progress callback that takes the number of total bytes written during the copy action. It is first invoked after some byte were written.

Returns:

this for chaining

Since:

11.0.3

build

@Nonnull
public ESuccess build()

This method performs the main copying

Specified by:

build in interface IBuilder<ESuccess>

Returns:

The built object. May not be null.