org.cryptomator.frontend.dokany

Class OpenFile

java.lang.Object

org.cryptomator.frontend.dokany.OpenHandle

org.cryptomator.frontend.dokany.OpenFile

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class OpenFile
extends OpenHandle

Field Summary

Fields inherited from class org.cryptomator.frontend.dokany.OpenHandle

path

Constructor Summary

Constructors

Constructor and Description
OpenFile(java.nio.file.Path path, java.util.Set<? extends java.nio.file.OpenOption> options, java.nio.file.attribute.FileAttribute<?>... attrs)

Method Summary

Modifier and Type	Method and Description
boolean	canBeDeleted() Test via acquiring a FileLock if we can delete this file.
void	close()
void	flush()
boolean	isRegularFile()
int	read(com.sun.jna.Pointer buf, long num, long offset) Reads up to num bytes beginning at offset into buf
java.lang.String	toString()
void	truncate(long size)
int	write(com.sun.jna.Pointer buf, long num, long offset) Writes up to num bytes from buf from offset into the current file

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenFile

public OpenFile(java.nio.file.Path path,
                java.util.Set<? extends java.nio.file.OpenOption> options,
                java.nio.file.attribute.FileAttribute<?>... attrs)
         throws java.io.IOException

Throws:

java.io.IOException

Method Detail

read

public int read(com.sun.jna.Pointer buf,
                long num,
                long offset)
         throws java.io.IOException

Reads up to num bytes beginning at offset into buf

Parameters:

buf - Buffer

num - Number of bytes to read

offset - Position of first byte to read

Returns:

Actual number of bytes read (can be less than size if reached EOF).

Throws:

java.io.IOException - If an exception occurs during read.

write

public int write(com.sun.jna.Pointer buf,
                 long num,
                 long offset)
          throws java.io.IOException

Writes up to num bytes from buf from offset into the current file

Parameters:

buf - Buffer

num - Number of bytes to write

offset - Position of first byte to write at

Returns:

Actual number of bytes written TODO: only the bytes which contains information or also some filling zeros?

Throws:

java.io.IOException - If an exception occurs during write.

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class OpenHandle

Throws:

java.io.IOException

isRegularFile

public boolean isRegularFile()

Specified by:

isRegularFile in class OpenHandle

flush

public void flush()
           throws java.io.IOException

Throws:

java.io.IOException

truncate

public void truncate(long size)
              throws java.io.IOException

Throws:

java.io.IOException

canBeDeleted

public boolean canBeDeleted()

Test via acquiring a FileLock if we can delete this file. TODO: should this lock be released or not? if not, we should rename the method!

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object