uk.ac.starlink.table.storage
Class FileByteStore

java.lang.Object
  extended by uk.ac.starlink.table.storage.FileByteStore
All Implemented Interfaces:
ByteStore

public class FileByteStore
extends Object
implements ByteStore

ByteStore implementation which uses a temporary file.

Since:
11 Jul 2008

Constructor Summary
FileByteStore()
          Constructs a new FileByteStore which uses a temporary file as backing store.
FileByteStore(File file)
          Constructs a new FileByteStore which uses the given file as a backing store.
 
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.
 File getFile()
          Returns the file used by this store.
 OutputStream getOutputStream()
          Returns an output stream which can be used to write to the store.
 ByteBuffer[] toByteBuffers()
          Returns an array of byte buffers containing the bytes written to this store.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileByteStore

public FileByteStore(File file)
              throws IOException
Constructs a new FileByteStore which uses the given file as a backing store. Nothing is done to mark this file as temporary.

Parameters:
file - location of the backing file which will be used
Throws:
IOException - if there is some I/O-related problem with opening the file
SecurityException - if the current security context does not allow writing to a temporary file

FileByteStore

public FileByteStore()
              throws IOException
Constructs a new FileByteStore which uses a temporary file as backing store. The temporary file will be written to the default temporary directory, given by the value of the java.io.tmpdir system property.

Throws:
IOException - if there is some I/O-related problem with opening the file
SecurityException - if the current security context does not allow writing to a temporary file
Method Detail

getFile

public File getFile()
Returns the file used by this store.

Returns:
file

getOutputStream

public OutputStream getOutputStream()
Description copied from interface: ByteStore
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.

Specified by:
getOutputStream in interface ByteStore
Returns:
data sink stream

copy

public void copy(OutputStream out)
          throws IOException
Description copied from interface: ByteStore
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.

Specified by:
copy in interface ByteStore
Parameters:
out - data destination stream
Throws:
IOException

toByteBuffers

public ByteBuffer[] toByteBuffers()
                           throws IOException
Description copied from interface: ByteStore
Returns an array of byte buffers containing the bytes written to this store. The stored bytes are all of the bytes from the first buffer in the returned array, followed by all in the second, etc. In many cases the returned array will, and probably should, contain a single buffer, but if the written byte count exceeds Integer.MAX_VALUE, more than one will be required. The limit of each buffer indicates the number of bytes it contains.

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

Specified by:
toByteBuffers in interface ByteStore
Returns:
byte buffer containing bytes written
Throws:
IOException - if there is an I/O error

close

public void close()
Description copied from interface: ByteStore
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.

Specified by:
close in interface ByteStore

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