Package nbbrd.io

Interface FileFormatter<T>

public interface FileFormatter<T>

Method Summary

Modifier and Type	Method	Description
default <V> @NonNull FileFormatter<V>	compose(@NonNull IOFunction<? super V,? extends T> before)
default void	formatFile(T value, @NonNull File target)
default void	formatPath(T value, @NonNull Path target)
void	formatStream(T value, @NonNull OutputStream resource)
default void	formatStream(T value, @NonNull IOSupplier<? extends OutputStream> target)
static <T> @NonNull FileFormatter<T>	onFormattingEncoder(@NonNull FileFormatter<T> formatter, @NonNull IOFunction<OutputStream,? extends FilterOutputStream> encoder)
static <T> @NonNull FileFormatter<T>	onFormattingGzip(@NonNull FileFormatter<T> formatter)	Deprecated. Use onFormattingEncoder(FileFormatter, IOFunction) instead
static <T> @NonNull FileFormatter<T>	onFormattingLock(@NonNull FileFormatter<T> formatter)
static <T> @NonNull FileFormatter<T>	onFormattingStream(@NonNull IOBiConsumer<? super T,? super OutputStream> function)

Method Details

formatFile

default void formatFile(@NonNull
 T value,
 @NonNull
 @NonNull File target)
                 throws IOException

Throws:

IOException

formatPath

default void formatPath(@NonNull
 T value,
 @NonNull
 @NonNull Path target)
                 throws IOException

Throws:

IOException

formatStream

default void formatStream(@NonNull
 T value,
 @NonNull
 @NonNull IOSupplier<? extends OutputStream> target)
                   throws IOException

Throws:

IOException

formatStream

void formatStream(@NonNull
 T value,
 @NonNull
 @NonNull OutputStream resource)
           throws IOException

Throws:

IOException

compose

@NonNull
default <V> @NonNull FileFormatter<V> compose(@NonNull
 @NonNull IOFunction<? super V,? extends T> before)

onFormattingStream

@NonNull
static <T> @NonNull FileFormatter<T> onFormattingStream(@NonNull
 @NonNull IOBiConsumer<? super T,? super OutputStream> function)

onFormattingGzip

@Deprecated
@NonNull
static <T> @NonNull FileFormatter<T> onFormattingGzip(@NonNull
 @NonNull FileFormatter<T> formatter)

Deprecated.

Use onFormattingEncoder(FileFormatter, IOFunction) instead

Type Parameters:

T - the type of the formatted object

Parameters:

formatter - the formatter to be wrapped

Returns:

a non-null FileFormatter that formats a GZIP compressed file

onFormattingEncoder

@NonNull
static <T> @NonNull FileFormatter<T> onFormattingEncoder(@NonNull
 @NonNull FileFormatter<T> formatter,
 @NonNull
 @NonNull IOFunction<OutputStream,? extends FilterOutputStream> encoder)

onFormattingLock

@NonNull
static <T> @NonNull FileFormatter<T> onFormattingLock(@NonNull
 @NonNull FileFormatter<T> formatter)