public final Class MappedDirectoryStream<T, R>

Class Inheritance

extends Object
implements DirectoryStream<R>

java.lang.Object
io.smallrye.common.resource.MappedDirectoryStream

All Implemented Interfaces

java.nio.file.DirectoryStream, java.lang.Iterable, java.io.Closeable, java.lang.AutoCloseable

Type Parameters

<T>: the input entry type
<R>: the output entry type

Imports

java.io.IOException, java.nio.file.DirectoryStream, java.util.Iterator, java.util.function.Function, io.smallrye.common.constraint.Assert

A directory stream to map one kind of entry to another.

Field Summary

Modifier and Type	Field and Description
private final DirectoryStream<T>	delegate
private final Function<T, R>	mappingFunction

Constructor Summary

Access	Constructor and Description
public	MappedDirectoryStream(final DirectoryStream<T> the delegate stream (must not be `null`) delegate, final Function<T, R> the mapping function (must not be `null`) mappingFunction) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public Iterator<R>	iterator() Implements java.nio.file.DirectoryStream.iterator. Returns the iterator associated with this `DirectoryStream`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegate	back to summary
private final DirectoryStream<T> delegate

mappingFunction	back to summary
private final Function<T, R> mappingFunction

Constructor Detail

MappedDirectoryStream back to summary

MappedDirectoryStream	back to summary
public MappedDirectoryStream(final DirectoryStream<T> delegate, final Function<T, R> mappingFunction) Construct a new instance. Parameters delegate:DirectoryStream<T> the delegate stream (must not be `null`) mappingFunction:Function<T, R> the mapping function (must not be `null`)

public MappedDirectoryStream(final DirectoryStream<T> delegate, final Function<T, R> mappingFunction)

Construct a new instance.

Parameters

delegate:DirectoryStream<T>: the delegate stream (must not be null)
mappingFunction:Function<T, R>: the mapping function (must not be null)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Exceptions

IOException:: if an I/O error occurs

iterator back to summary

iterator	back to summary
public Iterator<R> iterator() Implements java.nio.file.DirectoryStream.iterator. Doc from java.nio.file.DirectoryStream.iterator. Returns the iterator associated with this `DirectoryStream`. Returns:Iterator<R> the iterator associated with this `DirectoryStream`

public Iterator<R> iterator()

Implements java.nio.file.DirectoryStream.iterator.

Doc from java.nio.file.DirectoryStream.iterator.

Returns the iterator associated with this DirectoryStream.

Returns:Iterator<R>: the iterator associated with this DirectoryStream