uk.ac.starlink.table
Interface ByteStore

All Known Implementing Classes:
AdaptiveByteStore, DiscardByteStore, FileByteStore, MemoryByteStore

public interface ByteStore

Defines a place where bytes can be written to and then read from.

Since:
11 Jul 2008

Method Summary
 void close()
          Tidies up.
 void copy(OutputStream out)
          Takes all the data written so far into this store's sink stream and copies it to a destination stream.
 OutputStream getOutputStream()
          Returns an output stream which can be used to write to the store.
 ByteBuffer toByteBuffer()
          Returns a byte buffer containing the bytes written to this store.
 

Method Detail

getOutputStream

public OutputStream getOutputStream()
Returns an output stream which can be used to write to the store. May be called multiple times; always returns the same object. Note that this is not in general buffered - it is the responsibility of the user to take steps like wrapping it in a BufferedOutputStream for efficiency if required.

Returns:
data sink stream

copy

public void copy(OutputStream out)
          throws IOException
Takes all the data written so far into this store's sink stream and copies it to a destination stream. The output stream is not closed.

Parameters:
out - data destination stream
Throws:
IOException

toByteBuffer

public ByteBuffer toByteBuffer()
                        throws IOException
Returns a byte buffer containing the bytes written to this store. The buffer's limit indicates the amount of data written.

Usual usage will be to write all data, then call this method once; this model may affect implementation decisions about efficiency.

Returns:
byte buffer containing bytes written
Throws:
IOException - if there is a problem, including if the number of byte written exceeds Integer.MAX_VALUE

close

public void close()
Tidies up. Should be called when the data in this object is no longer required. This object may no longer be usable following a call to this method.


Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved.