Package com.helger.commons.io.stream

Class StreamHelper.CopyCharStreamBuilder

java.lang.Object

com.helger.commons.io.stream.StreamHelper.CopyCharStreamBuilder

All Implemented Interfaces:

IBuilder<ESuccess>

Enclosing class:

StreamHelper

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

A simple builder to copy a Reader (from(Reader)) to an Writer (to(Writer)) 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_FROM
static boolean	DEFAULT_CLOSE_TO

Constructor Summary

Constructors

Constructor	Description
CopyCharStreamBuilder()

Method Summary

Modifier and Type	Method	Description
StreamHelper.CopyCharStreamBuilder	buffer(char[] a)
ESuccess	build()	This method performs the main copying
StreamHelper.CopyCharStreamBuilder	closeFrom(boolean b)
StreamHelper.CopyCharStreamBuilder	closeTo(boolean b)
StreamHelper.CopyCharStreamBuilder	copyCharCount(MutableLong a)
StreamHelper.CopyCharStreamBuilder	exceptionCallback(IExceptionCallback<IOException> a)
StreamHelper.CopyCharStreamBuilder	from(Reader a)
StreamHelper.CopyCharStreamBuilder	limit(long n)
StreamHelper.CopyCharStreamBuilder	limit(Long a)
StreamHelper.CopyCharStreamBuilder	progressCallback(LongConsumer a)
StreamHelper.CopyCharStreamBuilder	to(Writer a)
StreamHelper.CopyCharStreamBuilder	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_FROM

public static final boolean DEFAULT_CLOSE_FROM

See Also:

Constant Field Values

DEFAULT_CLOSE_TO

public static final boolean DEFAULT_CLOSE_TO

See Also:

Constant Field Values

Constructor Detail

CopyCharStreamBuilder

public CopyCharStreamBuilder()

Method Detail

from

@Nonnull
public StreamHelper.CopyCharStreamBuilder from(@Nullable
                                               Reader a)

Parameters:

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

Returns:

this for chaining

closeFrom

@Nonnull
public StreamHelper.CopyCharStreamBuilder closeFrom(boolean b)

Parameters:

b - true to close the Reader, false to leave it open. Default is DEFAULT_CLOSE_FROM

Returns:

this for chaining

to

@Nonnull
public StreamHelper.CopyCharStreamBuilder to(@Nullable
                                             Writer a)

Parameters:

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

Returns:

this for chaining

closeTo

@Nonnull
public StreamHelper.CopyCharStreamBuilder closeTo(boolean b)

Parameters:

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

Returns:

this for chaining

buffer

@Nonnull
public StreamHelper.CopyCharStreamBuilder buffer(@Nullable
                                                 char[] a)

Parameters:

a - The buffer to use. May be null.

Returns:

this for chaining

limit

@Nonnull
public StreamHelper.CopyCharStreamBuilder limit(long n)

Parameters:

n - An optional maximum number of chars to copied from the Reader to the Writer. May be < 0 to indicate no limit, meaning all chars are copied.

Returns:

this for chaining

See Also:

unlimited()

limit

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

Parameters:

a - An optional maximum number of chars 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.CopyCharStreamBuilder unlimited()

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

Returns:

this for chaining

See Also:

limit(long)

exceptionCallback

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

Parameters:

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

Returns:

this for chaining

copyCharCount

@Nonnull
public StreamHelper.CopyCharStreamBuilder copyCharCount(@Nullable
                                                        MutableLong a)

Parameters:

a - An optional mutable long object that will receive the total number of copied chars. 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.CopyCharStreamBuilder progressCallback(@Nullable
                                                           LongConsumer a)

Parameters:

a - An optional progress callback that takes the number of total chars written during the copy action. It is first invoked after some chars 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.