FileBuffer (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- i2p.susi.util.FileBuffer

All Implemented Interfaces:
Buffer
Direct Known Subclasses:
GzipFileBuffer
```
public class FileBuffer
extends Object
implements Buffer
```
Buffer implementation backed by a file.

Field Summary
Fields
Modifier and Type Field and Description
protected File _file
the file
protected int _offset
the offset
protected int _sublen
the sub-length

Fields
Modifier and Type	Field and Description
`protected File`	`_file` the file
`protected int`	`_offset` the offset
`protected int`	`_sublen` the sub-length

Constructor Summary
Constructors
Constructor and Description
FileBuffer(File file)
Create a FileBuffer for the entire file.
FileBuffer(File file, int offset, int sublen)
Create a FileBuffer for a portion of the file.

Constructors
Constructor and Description
`FileBuffer(File file)` Create a FileBuffer for the entire file.
`FileBuffer(File file, int offset, int sublen)` Create a FileBuffer for a portion of the file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`File`	`getFile()`
`InputStream`	`getInputStream()` Get an InputStream for the file, skipping to the offset if needed.
`int`	`getLength()` Get the length of data in this buffer.
`int`	`getOffset()` Get the byte offset into the file.
`OutputStream`	`getOutputStream()` Get an OutputStream for the file.
`void`	`readComplete(boolean success)` Close the input stream.
`String`	`toString()`
`void`	`writeComplete(boolean success)` Close the output stream and delete the file if success is false.

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

- Field Detail
  - _file
```
protected final File _file
```
    the file
  - _offset
```
protected final int _offset
```
    the offset
  - _sublen
```
protected final int _sublen
```
    the sub-length
- Constructor Detail
  - FileBuffer
```
public FileBuffer(File file)
```
    Create a FileBuffer for the entire file.
    Parameters:
    file - the file to buffer
  - FileBuffer
```
public FileBuffer(File file,
                  int offset,
                  int sublen)
```
    Create a FileBuffer for a portion of the file.
    Parameters:
    file - the file to buffer
    offset - the byte offset to start reading from
    sublen - the number of bytes to read, or 0 for the entire file
- Method Detail
  - getFile
```
public File getFile()
```
    Returns:
    the underlying file
  - getInputStream
```
public InputStream getInputStream()
                           throws IOException
```
    Get an InputStream for the file, skipping to the offset if needed. Caller must call readComplete().
    Specified by:
    getInputStream in interface Buffer
    Returns:
    new FileInputStream
    Throws:
    IOException - on I/O error
  - getLength
```
public int getLength()
```
    Get the length of data in this buffer. Returns the sublen if set, otherwise the file length.
    Specified by:
    getLength in interface Buffer
    Returns:
    length in bytes
  - getOffset
```
public int getOffset()
```
    Get the byte offset into the file.
    Specified by:
    getOffset in interface Buffer
    Returns:
    offset in bytes
  - getOutputStream
```
public OutputStream getOutputStream()
                             throws IOException
```
    Get an OutputStream for the file. Caller must call writeComplete().
    Specified by:
    getOutputStream in interface Buffer
    Returns:
    new SecureFileOutputStream
    Throws:
    IOException - on I/O error
  - readComplete
```
public void readComplete(boolean success)
```
    Close the input stream.
    Specified by:
    readComplete in interface Buffer
    Parameters:
    success - ignored
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object
  - writeComplete
```
public void writeComplete(boolean success)
```
    Close the output stream and delete the file if success is false.
    Specified by:
    writeComplete in interface Buffer
    Parameters:
    success - if false, deletes the file

Class FileBuffer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_file

_offset

_sublen

Constructor Detail

FileBuffer

FileBuffer

Method Detail

getFile

getInputStream

getLength

getOffset

getOutputStream

readComplete

toString

writeComplete