Package io.deephaven.util.channel
Class LocalFSChannelProvider
java.lang.Object
io.deephaven.util.channel.LocalFSChannelProvider
- All Implemented Interfaces:
SeekableChannelsProvider
,SafeCloseable
,AutoCloseable
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
getInputStream
(SeekableByteChannel channel) Creates anInputStream
from the current position ofchannel
; closing the resulting input stream does not close thechannel
.getReadChannel
(@Nullable SeekableChannelContext channelContext, @NotNull URI uri) getWriteChannel
(@NotNull Path filePath, boolean append) boolean
isCompatibleWith
(@Nullable SeekableChannelContext channelContext) Check if the given context is compatible with this provider.Returns a stream of URIs, the elements of which are the entries in the directory.Create a newSeekableChannelContext
object for creating read channels via this provider.Returns a stream of URIs, the elements of which are all the files in the file tree rooted at the given starting directory.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.deephaven.util.channel.SeekableChannelsProvider
getReadChannel, getWriteChannel, makeSingleUseContext
-
Constructor Details
-
LocalFSChannelProvider
public LocalFSChannelProvider()
-
-
Method Details
-
makeContext
Description copied from interface:SeekableChannelsProvider
Create a newSeekableChannelContext
object for creating read channels via this provider.- Specified by:
makeContext
in interfaceSeekableChannelsProvider
-
isCompatibleWith
Description copied from interface:SeekableChannelsProvider
Check if the given context is compatible with this provider. Useful to test if we can use providedcontext
object for creating channels with this provider.- Specified by:
isCompatibleWith
in interfaceSeekableChannelsProvider
-
getReadChannel
public SeekableByteChannel getReadChannel(@Nullable @Nullable SeekableChannelContext channelContext, @NotNull @NotNull URI uri) throws IOException - Specified by:
getReadChannel
in interfaceSeekableChannelsProvider
- Throws:
IOException
-
getInputStream
Description copied from interface:SeekableChannelsProvider
Creates anInputStream
from the current position ofchannel
; closing the resulting input stream does not close thechannel
. TheInputStream
will be buffered; either explicitly in the case where the implementation uses an unbufferedSeekableChannelsProvider.getReadChannel(SeekableChannelContext, URI)
, or implicitly when the implementation uses a bufferedSeekableChannelsProvider.getReadChannel(SeekableChannelContext, URI)
.channel
must have been created bythis
provider. The caller can't assume the position ofchannel
after consuming theInputStream
. For use-cases that require the channel's position to be incremented the exact amount theInputStream
has been consumed, useSeekableChannelsProvider.channelPositionInputStream(SeekableChannelsProvider, SeekableByteChannel)
.- Specified by:
getInputStream
in interfaceSeekableChannelsProvider
- Parameters:
channel
- the channel- Returns:
- the input stream
-
getWriteChannel
public SeekableByteChannel getWriteChannel(@NotNull @NotNull Path filePath, boolean append) throws IOException - Specified by:
getWriteChannel
in interfaceSeekableChannelsProvider
- Throws:
IOException
-
list
Description copied from interface:SeekableChannelsProvider
Returns a stream of URIs, the elements of which are the entries in the directory. The listing is non-recursive. The URIs supplied by the stream will not have any unnecessary slashes or path separators. Also, the URIs will be file URIs (not ending with "/") irrespective of whether the URI corresponds to a file or a directory. The caller should manage file vs. directory handling in the processor. The caller is also responsible for closing the stream, preferably using a try-with-resources block.- Specified by:
list
in interfaceSeekableChannelsProvider
- Parameters:
directory
- the URI of the directory to list- Returns:
- The
Stream
ofURI
s - Throws:
IOException
-
walk
Description copied from interface:SeekableChannelsProvider
Returns a stream of URIs, the elements of which are all the files in the file tree rooted at the given starting directory. The URIs supplied by the stream will not have any unnecessary slashes or path separators. Also, the URIs will be file URIs (not ending with "/") irrespective of whether the URI corresponds to a file or a directory. The caller should manage file vs. directory handling in the processor. The caller is also responsible for closing the stream, preferably using a try-with-resources block.- Specified by:
walk
in interfaceSeekableChannelsProvider
- Parameters:
directory
- the URI of the directory to walk- Returns:
- The
Stream
ofURI
s - Throws:
IOException
-
close
public void close()- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceSafeCloseable
-