BinaryFileSource (MicroStream API 5.0)

java.lang.Object

one.microstream.persistence.binary.internal.BinaryFileSource

All Implemented Interfaces:: MessageWaiter, PersistenceSource<Binary>

public class BinaryFileSource
extends Object
implements PersistenceSource<Binary>, MessageWaiter

Method Summary

Modifier and Type	Method	Description
`static BinaryFileSource`	`New(AFile file, boolean switchByteOrder)`
`XGettingCollection<? extends Binary>`	`read()`	A general, unspecific read, e.g.
`XGettingCollection<? extends Binary>`	`readByObjectIds(PersistenceIdSet[] oids)`
`void`	`waitForBytes(int readCount)`

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.PersistenceSource

closeSource, prepareSource

Method Details
- New
  
  public static final BinaryFileSource New(AFile file, boolean switchByteOrder)
- read
  
  public 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
- readByObjectIds
  
  public XGettingCollection<? extends Binary> readByObjectIds(PersistenceIdSet[] oids) throws PersistenceExceptionTransfer
  
  Specified by:
  
  readByObjectIds in interface PersistenceSource<Binary>
  
  Throws:
  
  PersistenceExceptionTransfer
- waitForBytes
  
  public void waitForBytes(int readCount)
  
  Specified by:
  
  waitForBytes in interface MessageWaiter