Package io.deephaven.util.channel

Interface SeekableChannelContext

All Superinterfaces:

AutoCloseable, Function<Supplier<SafeCloseable>,SafeCloseable>, SafeCloseable

All Known Implementing Classes:

BaseSeekableChannelContext

public interface SeekableChannelContext
extends Function<Supplier<SafeCloseable>,SafeCloseable>, SafeCloseable

Context object for reading and writing to channels created by SeekableChannelsProvider.

The context object can hold a SafeCloseable resource, which can be plugged into the context by calling the apply(Supplier) method. The resource will be closed when the context is closed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SeekableChannelContext.ContextHolder

Field Summary

Fields

Modifier and Type	Field	Description
static final SeekableChannelContext	NULL

Method Summary

Modifier and Type	Method	Description
@Nullable SafeCloseable	apply(Supplier<SafeCloseable> resourceFactory)	If this instance holds a resource, return it.
default void	close()	Release any resources associated with this context.
static SeekableChannelContext.ContextHolder	ensureContext(SeekableChannelsProvider provider, SeekableChannelContext context)	A pattern that allows callers to ensure a valid context has been created for provider.

Methods inherited from interface java.util.function.Function

andThen, compose

Field Details

NULL

static final SeekableChannelContext NULL

Method Details

ensureContext

static SeekableChannelContext.ContextHolder ensureContext(SeekableChannelsProvider provider,
 SeekableChannelContext context)

A pattern that allows callers to ensure a valid context has been created for provider. In the case where the given context is compatible with provider, a no-op holder around that context will be returned. Otherwise, a holder with a new SeekableChannelsProvider.makeSingleUseContext() will be returned. The returned holder should ideally be used in a try-with-resources construction.

Parameters:

provider - the provider

context - the context

Returns:

the context holder

apply

@Nullable
@Nullable SafeCloseable apply(Supplier<SafeCloseable> resourceFactory)

If this instance holds a resource, return it. Otherwise, use the resource factory to create a new resource, store it, and return it. This method can return a null if the factory returns a null.

Specified by:

apply in interface Function<Supplier<SafeCloseable>,SafeCloseable>

close

default void close()

Release any resources associated with this context. The context should not be used afterward.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SafeCloseable