TAEnabledRandomAccessFile (Phynixx's Parent Project 3.0.0 API)

java.lang.Object
- org.csc.phynixx.loggersystem.logger.channellogger.TAEnabledRandomAccessFile

```
public class TAEnabledRandomAccessFile
extends Object
```
A TAEnabledRandomAccessFile provides random access to the file's content and let you append data to the current. It provides a simple but efficient atomic write. The first long of the file contains the committed size. Any content beyond the file pointer is ignored. To write bytes needs to operations. First these bytes are appended to the file. What is the second operation is to update the new commit position. The committed size is the size of the written and committed data. The visible size of the file contains the written data. It starts from the end of the header data and has the size of getCommittedSize() Data beyond this range cannot be read and is not available.
```
   |--------|----................---------|------
   0    start of                  committed size
       visible data                + header size

 
```
See Also:

FileChannel, RandomAccessFile, FileLock

Field Summary

Fields
Modifier and Type Field and Description

static int BYTE_BYTES
Groesse eines Bytes

static int HEADER_LENGTH
Header size.

static int MAX_BYTE_VALUE
max.

Fields
Modifier and Type	Field and Description
`static int`	`BYTE_BYTES` Groesse eines Bytes
`static int`	`HEADER_LENGTH` Header size.
`static int`	`MAX_BYTE_VALUE` max.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`available()`
`void`	`close()` Schliesst die Datei und den FileChannel
`void`	`commit()` updates the first 4 bytes of the file with the current position of the randomAccessFile
`void`	`forwardWind()` sets the current position to end of the visible data.
`long`	`getCommittedSize()` Gibt die Groesse des Comitteten Bereichs in Byte zurueck.
`static int`	`getHeaderLength()` liefert die Groesse des Headerbereiches
`boolean`	`isClose()` zeigt an, ob die Instanz geschlossen ist
`byte[]`	`read(int length)` reads the next length bytes starting form the current file position.
`int`	`readInt()` reads the next INTEGER starting form the current file position.
`long`	`readLong()` reads the next LONG starting form the current file position.
`short`	`readShort()` reads the next SHORT starting form the current file position.
`void`	`reset()` updates the committed size with 0.
`void`	`rewind()` sets the current position to the start of the data.
`void`	`write(byte[] buffer)` appends a byte[] to the file, but doesn't commit.
`void`	`writeInt(int value)` appends an INT to the file, but doesn't commit
`void`	`writeLong(long value)` appends a LONG to the file, but doesn't commit
`void`	`writeShort(short value)` appends a SHORT to the file, but doesn't commit

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HEADER_LENGTH
```
public static final int HEADER_LENGTH
```
    Header size. As the header contains the commited size (of type long) the header size is 8
    
    See Also:
    
    Constant Field Values
  - BYTE_BYTES
```
public static final int BYTE_BYTES
```
    Groesse eines Bytes
    
    See Also:
    
    Constant Field Values
  - MAX_BYTE_VALUE
```
public static final int MAX_BYTE_VALUE
```
    max. Inhalt eines Byte als int *
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getHeaderLength
```
public static int getHeaderLength()
```
    liefert die Groesse des Headerbereiches
    
    Returns:
    
    Groesse des Header
  - available
```
public long available()
               throws IOException
```
    Returns:
    
    byte available starting from the current position to the visible end of the file (==committed size)
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Schliesst die Datei und den FileChannel
    
    Throws:
    
    IOException - , wenn das Schliessen schief geht.
  - isClose
```
public boolean isClose()
```
    zeigt an, ob die Instanz geschlossen ist
    
    Returns:
    
    true wenn die Datei geschlossen ist
  - getCommittedSize
```
public long getCommittedSize()
                      throws IOException
```
    Gibt die Groesse des Comitteten Bereichs in Byte zurueck. Da am Anfang der Datei die Dateigroesse geschrieben wird, ist die Mindest-Groesse 4. Bei 4 Byte sind also noch keine Daten in die Datei geschrieben worden.
    
    Returns:
    
    commited size (bytes)
    
    Throws:
    
    IOException - IO-Error
  - readInt
```
public int readInt()
            throws IOException
```
    reads the next INTEGER starting form the current file position. If there are not enough bytes available (from the current position to the visible end of the file) to read the data an exception is thrown.
    
    Returns:
    
    read value
    
    Throws:
    
    IOException - IO Error
  - readShort
```
public short readShort()
                throws IOException
```
    reads the next SHORT starting form the current file position. If there are not enough bytes available (from the current position to the visible end of the file) to read the data an exception is thrown.
    
    Returns:
    
    read value
    
    Throws:
    
    IOException - IO Error
  - readLong
```
public long readLong()
              throws IOException
```
    reads the next LONG starting form the current file position. If there are not enough bytes available (from the current position to the visible end of the file) to read the data an exception is thrown.
    
    Returns:
    
    read value
    
    Throws:
    
    IOException - IO Error
  - read
```
public byte[] read(int length)
            throws IOException
```
    reads the next length bytes starting form the current file position. If there are not enough bytes available (from the current position to the visible end of the file) to read the data an exception is thrown. overflow (position is beyond committed data), is kopiert den Bereich zwischen startPosition und enedPosition der Datei in den ByteBuffer. Es wird die Read-methode des RandomAccessFiles genommen, da sich herausgestellt hat, dass die Methode im Batchbetrieb etwas schneller ist als die Channel-methode. Ee werden bytes gelesen fuer die gilt: startPosition ≤ b < endPosition
    
    Parameters:
    
    length - umber of bytes to be read
    
    Returns:
    
    content
    
    Throws:
    
    IOException - IO Error
  - write
```
public void write(byte[] buffer)
           throws IOException
```
    appends a byte[] to the file, but doesn't commit. In order to re-read the content it is recommended to store the size of the byte[] before writing the byte[]. This value can be used as the value of parameter length.
    
    Parameters:
    
    buffer - value to be appended
    
    Throws:
    
    IOException - IO Error
    
    See Also:
    
    read(int)
  - writeShort
```
public void writeShort(short value)
                throws IOException
```
    appends a SHORT to the file, but doesn't commit
    
    Parameters:
    
    value - value to be appended
    
    Throws:
    
    IOException - IO Error
  - writeInt
```
public void writeInt(int value)
              throws IOException
```
    appends an INT to the file, but doesn't commit
    
    Parameters:
    
    value - value to be appended
    
    Throws:
    
    IOException - IO Error
  - writeLong
```
public void writeLong(long value)
               throws IOException
```
    appends a LONG to the file, but doesn't commit
    
    Parameters:
    
    value - value to be appended
    
    Throws:
    
    IOException - IO Error
  - rewind
```
public void rewind()
            throws IOException
```
    sets the current position to the start of the data. (position()==0)
    
    Throws:
    
    IOException
  - forwardWind
```
public void forwardWind()
                 throws IOException
```
    sets the current position to end of the visible data. (position()==getCommittedSize())
    
    Throws:
    
    IOException
  - reset
```
public void reset()
           throws IOException
```
    updates the committed size with 0. All data is truncated
    
    Throws:
    
    IOException
  - commit
```
public void commit()
            throws IOException
```
    updates the first 4 bytes of the file with the current position of the randomAccessFile
    
    Throws:
    
    IOException - Error updating the file

Class TAEnabledRandomAccessFile

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HEADER_LENGTH

BYTE_BYTES

MAX_BYTE_VALUE

Method Detail

getHeaderLength

available

close

isClose

getCommittedSize

readInt

readShort

readLong

read

write

writeShort

writeInt

writeLong

rewind

forwardWind

reset

commit