org.neo4j.io.fs

Class StoreFileChannel

java.lang.Object

org.neo4j.io.fs.StoreFileChannel

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, ByteChannel, Channel, GatheringByteChannel, InterruptibleChannel, ReadableByteChannel, ScatteringByteChannel, SeekableByteChannel, WritableByteChannel, StoreChannel

public class StoreFileChannel
extends Object
implements StoreChannel

Constructor Summary

Constructors

Constructor and Description
StoreFileChannel(FileChannel channel)
StoreFileChannel(StoreFileChannel channel)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
void	force(boolean metaData)
boolean	isOpen()
long	position()
StoreFileChannel	position(long newPosition)
int	read(ByteBuffer dst)
long	read(ByteBuffer[] dsts)
long	read(ByteBuffer[] dsts, int offset, int length)
int	read(ByteBuffer dst, long position)
long	size()
StoreFileChannel	truncate(long size)
FileLock	tryLock() Attempts to acquire an exclusive lock on this channel's file.
int	write(ByteBuffer src)
long	write(ByteBuffer[] srcs)
long	write(ByteBuffer[] srcs, int offset, int length)
int	write(ByteBuffer src, long position) NOTE: If you want to write bytes to disk, use #writeAll(), this does not guarantee all bytes will be written, and you are responsible for handling the return value of this call (which tells you how many bytes were written).
void	writeAll(ByteBuffer src) Same as #write(), except this method will write the full contents of the buffer in chunks if the OS fails to write it all at once.
void	writeAll(ByteBuffer src, long position) Same as #write(), except this method will write the full contents of the buffer in chunks if the OS fails to write it all at once.

Methods inherited from class java.lang.Object

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

Constructor Detail

StoreFileChannel

public StoreFileChannel(FileChannel channel)

StoreFileChannel

public StoreFileChannel(StoreFileChannel channel)

Method Detail

write

public long write(ByteBuffer[] srcs)
           throws IOException

Specified by:

write in interface GatheringByteChannel

Throws:

IOException

write

public int write(ByteBuffer src,
                 long position)
          throws IOException

Description copied from interface: StoreChannel

NOTE: If you want to write bytes to disk, use #writeAll(), this does not guarantee all bytes will be written, and you are responsible for handling the return value of this call (which tells you how many bytes were written).

Specified by:

write in interface StoreChannel

Throws:

IOException

write

public long write(ByteBuffer[] srcs,
                  int offset,
                  int length)
           throws IOException

Specified by:

write in interface GatheringByteChannel

Throws:

IOException

writeAll

public void writeAll(ByteBuffer src,
                     long position)
              throws IOException

Description copied from interface: StoreChannel

Same as #write(), except this method will write the full contents of the buffer in chunks if the OS fails to write it all at once.

Specified by:

writeAll in interface StoreChannel

Throws:

IOException

writeAll

public void writeAll(ByteBuffer src)
              throws IOException

Description copied from interface: StoreChannel

Same as #write(), except this method will write the full contents of the buffer in chunks if the OS fails to write it all at once.

Specified by:

writeAll in interface StoreChannel

Throws:

IOException

truncate

public StoreFileChannel truncate(long size)
                          throws IOException

Specified by:

truncate in interface SeekableByteChannel

Specified by:

truncate in interface StoreChannel

Throws:

IOException

position

public StoreFileChannel position(long newPosition)
                          throws IOException

Specified by:

position in interface SeekableByteChannel

Specified by:

position in interface StoreChannel

Throws:

IOException

read

public int read(ByteBuffer dst,
                long position)
         throws IOException

Specified by:

read in interface StoreChannel

Throws:

IOException

See Also:

FileChannel.read(java.nio.ByteBuffer, long)

force

public void force(boolean metaData)
           throws IOException

Specified by:

force in interface StoreChannel

Throws:

IOException

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Specified by:

read in interface SeekableByteChannel

Throws:

IOException

read

public long read(ByteBuffer[] dsts,
                 int offset,
                 int length)
          throws IOException

Specified by:

read in interface ScatteringByteChannel

Throws:

IOException

position

public long position()
              throws IOException

Specified by:

position in interface SeekableByteChannel

Throws:

IOException

tryLock

public FileLock tryLock()
                 throws IOException

Description copied from interface: StoreChannel

Attempts to acquire an exclusive lock on this channel's file.

Specified by:

tryLock in interface StoreChannel

Returns:

A lock object representing the newly-acquired lock, or null if the lock could not be acquired.

Throws:

IOException - If an I/O error occurs.

ClosedChannelException - if the channel is closed.

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

read

public long read(ByteBuffer[] dsts)
          throws IOException

Specified by:

read in interface ScatteringByteChannel

Throws:

IOException

write

public int write(ByteBuffer src)
          throws IOException

Specified by:

write in interface SeekableByteChannel

Specified by:

write in interface WritableByteChannel

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface InterruptibleChannel

Throws:

IOException

size

public long size()
          throws IOException

Specified by:

size in interface SeekableByteChannel

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException