Package one.microstream.persistence.binary.internal

Class BinaryStorageChannel

java.lang.Object

one.microstream.persistence.binary.internal.BinaryStorageChannel

All Implemented Interfaces:

WriteController, PersistenceChannel<Binary>, PersistenceSource<Binary>, PersistenceTarget<Binary>, PersistenceWriteController

public final class BinaryStorageChannel
extends Object
implements PersistenceChannel<Binary>

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.persistence.types.PersistenceWriteController

PersistenceWriteController.Disabled, PersistenceWriteController.Enabled, PersistenceWriteController.Wrapper

Constructor Summary

Constructors

Constructor	Description
BinaryStorageChannel(PersistenceSource<Binary> source, PersistenceTarget<Binary> target)

Method Summary

Modifier and Type	Method	Description
boolean	isStoringEnabled()
boolean	isWritable()
XGettingCollection<? extends Binary>	read()	A general, unspecific read, e.g.
XGettingCollection<? extends Binary>	readByObjectIds(PersistenceIdSet[] oids)
void	validateIsStoringEnabled()
void	validateIsWritable()
void	write(Binary data)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface one.microstream.persistence.types.PersistenceChannel

closeChannel, prepareChannel

Methods inherited from interface one.microstream.persistence.types.PersistenceSource

closeSource, prepareSource

Methods inherited from interface one.microstream.persistence.types.PersistenceTarget

closeTarget, prepareTarget

Constructor Details

BinaryStorageChannel

public BinaryStorageChannel(PersistenceSource<Binary> source, PersistenceTarget<Binary> target)

Method Details

write

public final void write(Binary data) throws PersistenceExceptionTransfer

Specified by:

write in interface PersistenceTarget<Binary>

Throws:

PersistenceExceptionTransfer

read

public final XGettingCollection<? extends Binary> read() throws PersistenceExceptionTransfer

Description copied from interface: PersistenceSource

A general, unspecific read, e.g. to initially read data in general from the attached data source.

Examples:

• simply ALL data from a plain file.
• only root nodes (and all recursively referenced nodes) of a graph-based database.
• nothing at all if not applicable, resulting in null being returned.

Specified by:

read in interface PersistenceSource<Binary>

Returns:

data segments containing general data if applicable, otherwise null.

Throws:

PersistenceExceptionTransfer - if a transfer error occurs

readByObjectIds

public final XGettingCollection<? extends Binary> readByObjectIds(PersistenceIdSet[] oids) throws PersistenceExceptionTransfer

Specified by:

readByObjectIds in interface PersistenceSource<Binary>

Throws:

PersistenceExceptionTransfer

validateIsWritable

public final void validateIsWritable()

Specified by:

validateIsWritable in interface WriteController

isWritable

public final boolean isWritable()

Specified by:

isWritable in interface WriteController

validateIsStoringEnabled

public void validateIsStoringEnabled()

Specified by:

validateIsStoringEnabled in interface PersistenceWriteController

isStoringEnabled

public boolean isStoringEnabled()

Specified by:

isStoringEnabled in interface PersistenceWriteController