com.github.jinahya.simple.file.back

Interface FileContext

All Known Implementing Classes:

AbstractFileContext, DefaultFileContext

public interface FileContext

A context between clients and file backs.

Author:

Jin Kwon <jinahya_at_gmail.com>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileContext.PropertyKey Properties can be configured within file contexts.

Method Summary

Modifier and Type	Method and Description
default java.util.function.Supplier<FileBack.FileOperation>	fileOperationSupplier() Return the current property value mapped to FileContext.PropertyKey.FILE_OPERATION_SUPPLIER.
default java.util.function.Supplier<FileBack.FileOperation>	fileOperationSupplier(java.util.function.Supplier<FileBack.FileOperation> fileOperationSupplier) Sets a new property value mapped to FileContext.PropertyKey.FILE_OPERATION_SUPPLIER.
default java.util.function.Consumer<String>	pathNameConsumer()
default java.util.function.Consumer<String>	pathNameConsumer(java.util.function.Consumer<String> pathNameConsumer)
default java.util.function.Supplier<String>	pathNameSupplier()
default java.util.function.Supplier<String>	pathNameSupplier(java.util.function.Supplier<String> pathNameSupplier)
Optional<Object>	property(FileContext.PropertyKey propertyKey) Returns an optional property value mapped to specified propertyKey.
default <T> Optional<T>	property(FileContext.PropertyKey proprtyKey, Class<T> valueType) Returns an optional property value mapped to specified propertyKey.
Optional<Object>	property(FileContext.PropertyKey propertyKey, Object propertyValue) Sets a new property value mapped to specified propertyKey.
default <T> Optional<T>	property(FileContext.PropertyKey propertyKey, T propertyValue, Class<T> valueType) Sets a new property value mapped to specified propertyKey.
default java.util.function.Consumer<ReadableByteChannel>	sourceChannelConsumer()
default java.util.function.Consumer<ReadableByteChannel>	sourceChannelConsumer(java.util.function.Consumer<ReadableByteChannel> sourceChannelConsumer)
default java.util.function.Supplier<ReadableByteChannel>	sourceChannelSupplier()
default java.util.function.Supplier<ReadableByteChannel>	sourceChannelSupplier(java.util.function.Supplier<ReadableByteChannel> sourceChannelSuppleir)
default java.util.function.Consumer<Long>	sourceCopiedConsumer() Returns the current property value mapped to FileContext.PropertyKey.SOURCE_COPIED_CONSUMER.
default java.util.function.Consumer<Long>	sourceCopiedConsumer(java.util.function.Consumer<Long> sourceCopiedConsumer) Sets the new value for FileContext.PropertyKey.SOURCE_COPIED_CONSUMER.
default java.util.function.Supplier<ByteBuffer>	sourceKeySupplier()
default java.util.function.Supplier<ByteBuffer>	sourceKeySupplier(java.util.function.Supplier<ByteBuffer> sourceKeySupplier)
default java.util.function.Consumer<Object>	sourceObjectConsumer()
default java.util.function.Consumer<Object>	sourceObjectConsumer(java.util.function.Consumer<Object> sourceObjectConsumer)
default java.util.function.Consumer<WritableByteChannel>	targetChannelConsumer()
default java.util.function.Consumer<WritableByteChannel>	targetChannelConsumer(java.util.function.Consumer<WritableByteChannel> targetChannelConsumer)
default java.util.function.Supplier<WritableByteChannel>	targetChannelSupplier()
default java.util.function.Supplier<WritableByteChannel>	targetChannelSupplier(java.util.function.Supplier<WritableByteChannel> targetChannelSupplier)
default java.util.function.Consumer<Long>	targetCopiedConsumer()
default java.util.function.Consumer<Long>	targetCopiedConsumer(java.util.function.Consumer<Long> targetCopiedConsumer)
default java.util.function.Supplier<ByteBuffer>	targetKeySupplier()
default java.util.function.Supplier<ByteBuffer>	targetKeySupplier(java.util.function.Supplier<ByteBuffer> targetKeySupplier)
default java.util.function.Consumer<Object>	targetObjectConsumer()
default java.util.function.Consumer<Object>	targetObjectConsumer(java.util.function.Consumer<Object> targetObjectConsumer)

Method Detail

property

Optional<Object> property(FileContext.PropertyKey propertyKey)

Returns an optional property value mapped to specified propertyKey.

Parameters:

propertyKey - the property key

Returns:

an optional value.

property

default <T> Optional<T> property(FileContext.PropertyKey proprtyKey,
                                 Class<T> valueType)

Returns an optional property value mapped to specified propertyKey.

Type Parameters:

T - value type parameter

Parameters:

proprtyKey - property key

valueType - value type.

Returns:

an optional value of property.

property

Optional<Object> property(FileContext.PropertyKey propertyKey,
                          Object propertyValue)

Sets a new property value mapped to specified propertyKey. Note that providing null for propertyValue will remove previous mapping.

Parameters:

propertyKey - the property key

propertyValue - the property value; null for removal of mapping.

Returns:

an optional property value previously mapped to specified propertyKey.

property

default <T> Optional<T> property(FileContext.PropertyKey propertyKey,
                                 T propertyValue,
                                 Class<T> valueType)

Sets a new property value mapped to specified propertyKey.

Type Parameters:

T - value type parameter

Parameters:

propertyKey - property key

propertyValue - the new property value.

valueType - value type.

Returns:

an optional property value previously mapped to specified propertyKey.

fileOperationSupplier

default java.util.function.Supplier<FileBack.FileOperation> fileOperationSupplier()

Return the current property value mapped to FileContext.PropertyKey.FILE_OPERATION_SUPPLIER.

Returns:

the current value mapped to FileContext.PropertyKey.FILE_OPERATION_SUPPLIER or null if no mappings found.

fileOperationSupplier

default java.util.function.Supplier<FileBack.FileOperation> fileOperationSupplier(java.util.function.Supplier<FileBack.FileOperation> fileOperationSupplier)

Sets a new property value mapped to FileContext.PropertyKey.FILE_OPERATION_SUPPLIER.

Parameters:

fileOperationSupplier - the new value.

Returns:

the previous value mapped to FileContext.PropertyKey.FILE_OPERATION_SUPPLIER or null if there is no mappings.

pathNameConsumer

default java.util.function.Consumer<String> pathNameConsumer()

pathNameConsumer

default java.util.function.Consumer<String> pathNameConsumer(java.util.function.Consumer<String> pathNameConsumer)

pathNameSupplier

default java.util.function.Supplier<String> pathNameSupplier()

pathNameSupplier

default java.util.function.Supplier<String> pathNameSupplier(java.util.function.Supplier<String> pathNameSupplier)

sourceChannelConsumer

default java.util.function.Consumer<ReadableByteChannel> sourceChannelConsumer()

sourceChannelConsumer

default java.util.function.Consumer<ReadableByteChannel> sourceChannelConsumer(java.util.function.Consumer<ReadableByteChannel> sourceChannelConsumer)

sourceChannelSupplier

default java.util.function.Supplier<ReadableByteChannel> sourceChannelSupplier()

sourceChannelSupplier

default java.util.function.Supplier<ReadableByteChannel> sourceChannelSupplier(java.util.function.Supplier<ReadableByteChannel> sourceChannelSuppleir)

sourceCopiedConsumer

default java.util.function.Consumer<Long> sourceCopiedConsumer()

Returns the current property value mapped to FileContext.PropertyKey.SOURCE_COPIED_CONSUMER.

Returns:

the current property value mapped to FileContext.PropertyKey.SOURCE_COPIED_CONSUMER or null if no mappings found.

sourceCopiedConsumer

default java.util.function.Consumer<Long> sourceCopiedConsumer(java.util.function.Consumer<Long> sourceCopiedConsumer)

Sets the new value for FileContext.PropertyKey.SOURCE_COPIED_CONSUMER.

Parameters:

sourceCopiedConsumer - the new value; null for removal of entry.

Returns:

previous value mapped; possibly null.

sourceKeySupplier

default java.util.function.Supplier<ByteBuffer> sourceKeySupplier()

sourceKeySupplier

default java.util.function.Supplier<ByteBuffer> sourceKeySupplier(java.util.function.Supplier<ByteBuffer> sourceKeySupplier)

sourceObjectConsumer

default java.util.function.Consumer<Object> sourceObjectConsumer()

sourceObjectConsumer

default java.util.function.Consumer<Object> sourceObjectConsumer(java.util.function.Consumer<Object> sourceObjectConsumer)

targetCopiedConsumer

default java.util.function.Consumer<Long> targetCopiedConsumer()

targetCopiedConsumer

default java.util.function.Consumer<Long> targetCopiedConsumer(java.util.function.Consumer<Long> targetCopiedConsumer)

targetKeySupplier

default java.util.function.Supplier<ByteBuffer> targetKeySupplier()

targetKeySupplier

default java.util.function.Supplier<ByteBuffer> targetKeySupplier(java.util.function.Supplier<ByteBuffer> targetKeySupplier)

targetChannelConsumer

default java.util.function.Consumer<WritableByteChannel> targetChannelConsumer()

targetChannelConsumer

default java.util.function.Consumer<WritableByteChannel> targetChannelConsumer(java.util.function.Consumer<WritableByteChannel> targetChannelConsumer)

targetChannelSupplier

default java.util.function.Supplier<WritableByteChannel> targetChannelSupplier()

targetChannelSupplier

default java.util.function.Supplier<WritableByteChannel> targetChannelSupplier(java.util.function.Supplier<WritableByteChannel> targetChannelSupplier)

targetObjectConsumer

default java.util.function.Consumer<Object> targetObjectConsumer()

targetObjectConsumer

default java.util.function.Consumer<Object> targetObjectConsumer(java.util.function.Consumer<Object> targetObjectConsumer)