RawFileOperationSupport

All Known Implementing Classes:

AbstractRawFileOperationSupport, PosixRawFileOperationSupport
```
public interface RawFileOperationSupport
```
Provides an OS-independent abstraction for operations on files. Most of the code is implemented in a way that it can be used from uninterruptible code.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`RawFileOperationSupport.FileAccessMode` The file access modes that can be used when opening/creating a file.
`static interface`	`RawFileOperationSupport.RawFileDescriptor` OS-specific signed value that represents a file descriptor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static RawFileOperationSupport`	`bigEndian()` Returns a `RawFileOperationSupport` singleton that uses big endian byte ordering.
`boolean`	`close(RawFileOperationSupport.RawFileDescriptor fd)` Closes a file descriptor.
`boolean`	`isValid(RawFileOperationSupport.RawFileDescriptor fd)` Checks if a file descriptor is valid or if it represents an error value.
`static RawFileOperationSupport`	`littleEndian()` Returns a `RawFileOperationSupport` singleton that uses little endian byte ordering.
`static RawFileOperationSupport`	`nativeByteOrder()` Returns a `RawFileOperationSupport` singleton that uses the native byte ordering of the underlying architecture.
`RawFileOperationSupport.RawFileDescriptor`	`open(File file, RawFileOperationSupport.FileAccessMode mode)` Opens or creates a file with the specified `access mode`.
`RawFileOperationSupport.RawFileDescriptor`	`open(String filename, RawFileOperationSupport.FileAccessMode mode)` Opens or creates a file with the specified `access mode`.
`org.graalvm.word.SignedWord`	`position(RawFileOperationSupport.RawFileDescriptor fd)` Gets the current file position within a file.
`org.graalvm.word.SignedWord`	`read(RawFileOperationSupport.RawFileDescriptor fd, org.graalvm.word.Pointer buffer, org.graalvm.word.UnsignedWord bufferSize)` Reads up to bufferSize bytes of data from to the current file position and advances the file position.
`boolean`	`seek(RawFileOperationSupport.RawFileDescriptor fd, org.graalvm.word.SignedWord position)` Sets the current file position within a file.
`org.graalvm.word.SignedWord`	`size(RawFileOperationSupport.RawFileDescriptor fd)` Returns the size of a file.
`boolean`	`write(RawFileOperationSupport.RawFileDescriptor fd, byte[] data)` Writes data to the current file position and advances the file position.
`boolean`	`write(RawFileOperationSupport.RawFileDescriptor fd, org.graalvm.word.Pointer data, org.graalvm.word.UnsignedWord size)` Writes data to the current file position and advances the file position.
`boolean`	`writeBoolean(RawFileOperationSupport.RawFileDescriptor fd, boolean data)` Writes data to the current file position and advances the file position.
`boolean`	`writeByte(RawFileOperationSupport.RawFileDescriptor fd, byte data)` Writes data to the current file position and advances the file position.
`boolean`	`writeChar(RawFileOperationSupport.RawFileDescriptor fd, char data)` Writes a char value in the specified byte ordering to the current file position and advances the file position.
`boolean`	`writeInt(RawFileOperationSupport.RawFileDescriptor fd, int data)` Writes an integer value in the specified byte ordering to the current file position and advances the file position.
`boolean`	`writeLong(RawFileOperationSupport.RawFileDescriptor fd, long data)` Writes a long value in the specified byte ordering to the current file position and advances the file position.
`boolean`	`writeShort(RawFileOperationSupport.RawFileDescriptor fd, short data)` Writes a short value in the specified byte ordering to the current file position and advances the file position.

- Method Detail
  - littleEndian
```
static RawFileOperationSupport littleEndian()
```
    Returns a RawFileOperationSupport singleton that uses little endian byte ordering.
  - bigEndian
```
static RawFileOperationSupport bigEndian()
```
    Returns a RawFileOperationSupport singleton that uses big endian byte ordering.
  - nativeByteOrder
```
static RawFileOperationSupport nativeByteOrder()
```
    Returns a RawFileOperationSupport singleton that uses the native byte ordering of the underlying architecture.
  - open
```
RawFileOperationSupport.RawFileDescriptor open(String filename,
                                               RawFileOperationSupport.FileAccessMode mode)
```
    Opens or creates a file with the specified access mode.
    
    Returns:
    
    If the operation is successful, it returns the file descriptor. Otherwise, it returns a value where RawFileOperationSupport.isValid(com.oracle.svm.core.os.RawFileOperationSupport.RawFileDescriptor) will return false.
  - open
```
RawFileOperationSupport.RawFileDescriptor open(File file,
                                               RawFileOperationSupport.FileAccessMode mode)
```
    Opens or creates a file with the specified access mode.
    
    Returns:
    
    If the operation is successful, it returns the file descriptor. Otherwise, it returns a value where RawFileOperationSupport.isValid(com.oracle.svm.core.os.RawFileOperationSupport.RawFileDescriptor) will return false.
  - isValid
```
boolean isValid(RawFileOperationSupport.RawFileDescriptor fd)
```
    Checks if a file descriptor is valid or if it represents an error value.
    
    Returns:
    
    true if the file descriptor is valid, false otherwise.
  - close
```
boolean close(RawFileOperationSupport.RawFileDescriptor fd)
```
    Closes a file descriptor.
    
    Returns:
    
    true if the file descriptor was closed by the call, false otherwise.
  - size
```
org.graalvm.word.SignedWord size(RawFileOperationSupport.RawFileDescriptor fd)
```
    Returns the size of a file.
    
    Returns:
    
    If the operation is successful, it returns the size of the file. Otherwise, it returns a value less than 0.
  - position
```
org.graalvm.word.SignedWord position(RawFileOperationSupport.RawFileDescriptor fd)
```
    Gets the current file position within a file.
    
    Returns:
    
    If the operation is successful, it returns the current file position. Otherwise, it returns a value less than 0.
  - seek
```
boolean seek(RawFileOperationSupport.RawFileDescriptor fd,
             org.graalvm.word.SignedWord position)
```
    Sets the current file position within a file.
    
    Returns:
    
    true if the file position was updated to the given value, false otherwise.
  - write
```
boolean write(RawFileOperationSupport.RawFileDescriptor fd,
              org.graalvm.word.Pointer data,
              org.graalvm.word.UnsignedWord size)
```
    Writes data to the current file position and advances the file position.
    
    Returns:
    
    true if the data was written, false otherwise.
  - write
```
boolean write(RawFileOperationSupport.RawFileDescriptor fd,
              byte[] data)
```
    Writes data to the current file position and advances the file position.
    
    Returns:
    
    true if the data was written, false otherwise.
  - writeBoolean
```
boolean writeBoolean(RawFileOperationSupport.RawFileDescriptor fd,
                     boolean data)
```
    Writes data to the current file position and advances the file position.
    
    Returns:
    
    true if the data was written, false otherwise.
  - writeByte
```
boolean writeByte(RawFileOperationSupport.RawFileDescriptor fd,
                  byte data)
```
    Writes data to the current file position and advances the file position.
    
    Returns:
    
    true if the data was written, false otherwise.
  - writeShort
```
boolean writeShort(RawFileOperationSupport.RawFileDescriptor fd,
                   short data)
```
    Writes a short value in the specified byte ordering to the current file position and advances the file position.
    
    Returns:
    
    true if the data was written, false otherwise.
  - writeChar
```
boolean writeChar(RawFileOperationSupport.RawFileDescriptor fd,
                  char data)
```
    Writes a char value in the specified byte ordering to the current file position and advances the file position.
    
    Returns:
    
    true if the data was written, false otherwise.
  - writeInt
```
boolean writeInt(RawFileOperationSupport.RawFileDescriptor fd,
                 int data)
```
    Writes an integer value in the specified byte ordering to the current file position and advances the file position.
    
    Returns:
    
    true if the data was written, false otherwise.
  - writeLong
```
boolean writeLong(RawFileOperationSupport.RawFileDescriptor fd,
                  long data)
```
    Writes a long value in the specified byte ordering to the current file position and advances the file position.
    
    Returns:
    
    true if the data was written, false otherwise.
  - read
```
org.graalvm.word.SignedWord read(RawFileOperationSupport.RawFileDescriptor fd,
                                 org.graalvm.word.Pointer buffer,
                                 org.graalvm.word.UnsignedWord bufferSize)
```
    Reads up to bufferSize bytes of data from to the current file position and advances the file position.
    
    Returns:
    
    If the operation is successful, it returns the number of read bytes. Otherwise, it returns a negative value.

Interface RawFileOperationSupport

Nested Class Summary

Method Summary

Method Detail

littleEndian

bigEndian

nativeByteOrder

open

open

isValid

close

size

position

seek

write

write

writeBoolean

writeByte

writeShort

writeChar

writeInt

writeLong

read