GzipFileBuffer

java.lang.Object

i2p.susi.util.FileBuffer

i2p.susi.util.GzipFileBuffer

All Implemented Interfaces:: Buffer

public class GzipFileBufferextends FileBuffer

Gzip-compressed file Buffer implementation.

Field Summary
Fields
Modifier and Type
Field
Description
private long
_actualLength
Length of the decoded data, in bytes.
private CountingInputStream
_cis
Stream counting the bytes read.
private CountingOutputStream
_cos
Stream counting the bytes written.
Fields inherited from class FileBuffer
_file, _offset, _sublen
Modifier and Type
Field
Description
protected final File
_file
The file.
protected final int
_offset
The offset.
protected final int
_sublen
The sub-length.
Constructor Summary
Constructors
Constructor
Description
GzipFileBuffer(File file)
Create a GzipFileBuffer for the entire file.
GzipFileBuffer(File file, int offset, int sublen)
Create a GzipFileBuffer for a portion of the uncompressed data.
Method Summary
All Methods
Modifier and Type
Method
Description
InputStream
getInputStream()
Get a GZIP decompressing InputStream, wrapped with a counter.
int
getLength()
Returns the actual uncompressed size.
OutputStream
getOutputStream()
Get a GZIP compressing OutputStream, wrapped with a counter.
void
readComplete(boolean success)
Close the input stream and record the uncompressed length if successful.
String
toString()

void
writeComplete(boolean success)
Close the output stream and record the uncompressed length if successful.
Methods inherited from class FileBuffer
getFile, getOffset
Modifier and Type
Method
Description
File
getFile()
Get the file being buffered.
int
getOffset()
Get the byte offset into the file.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- _actualLength
  private long _actualLength
  Length of the decoded data, in bytes.
- _cis
  private CountingInputStream _cis
  Stream counting the bytes read.
- _cos
  private CountingOutputStream _cos
  Stream counting the bytes written.
Constructor Details
- GzipFileBuffer
  public GzipFileBuffer(File file)
  Create a GzipFileBuffer for the entire file.
  Parameters:
  file - the gzip-compressed file
- GzipFileBuffer
  public GzipFileBuffer(File file, int offset, int sublen)
  Create a GzipFileBuffer for a portion of the uncompressed data.
  Parameters:
  file - the gzip-compressed file
  offset - the byte offset to start reading from (uncompressed)
  sublen - the number of bytes to read (uncompressed), or 0 for all
Method Details
- getInputStream
  public InputStream getInputStream() throws IOException
  Get a GZIP decompressing InputStream, wrapped with a counter. Caller must call readComplete(boolean).
  Specified by:
  getInputStream in interface Buffer
  Overrides:
  getInputStream in class FileBuffer
  Returns:
  new InputStream chain for reading uncompressed data
  Throws:
  IOException - on I/O error
- getOutputStream
  public OutputStream getOutputStream() throws IOException
  Get a GZIP compressing OutputStream, wrapped with a counter. Caller must call writeComplete(boolean).
  Specified by:
  getOutputStream in interface Buffer
  Overrides:
  getOutputStream in class FileBuffer
  Returns:
  new OutputStream chain for writing compressed data
  Throws:
  IllegalStateException - if offset > 0 or already open for writing
  IOException - on I/O error
- readComplete
  public void readComplete(boolean success)
  Close the input stream and record the uncompressed length if successful.
  Specified by:
  readComplete in interface Buffer
  Overrides:
  readComplete in class FileBuffer
  Parameters:
  success - if true, records the bytes read
- writeComplete
  public void writeComplete(boolean success)
  Close the output stream and record the uncompressed length if successful.
  Specified by:
  writeComplete in interface Buffer
  Overrides:
  writeComplete in class FileBuffer
  Parameters:
  success - if true, records the bytes written
- getLength
  public int getLength()
  Returns the actual uncompressed size. Only known after reading and calling readComplete(true), or after writing and calling writeComplete(true), otherwise returns 0.
  Specified by:
  getLength in interface Buffer
  Overrides:
  getLength in class FileBuffer
  Returns:
  the uncompressed length in bytes
- toString
  public String toString()
  Overrides:
  toString in class FileBuffer

Field Summary

Fields inherited from class FileBuffer

Constructor Summary

Method Summary

Methods inherited from class FileBuffer

Methods inherited from class Object

Field Details

_actualLength

_cis

_cos

Constructor Details

GzipFileBuffer

Method Details

getInputStream

getOutputStream

readComplete

writeComplete

getLength

toString