FndBufferedOutputStream (IFS Java Server Framework API documentation (for internal use only))

java.lang.Object
- java.io.OutputStream
- - ifs.fnd.record.serialization.FndBufferedOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
```
public class FndBufferedOutputStream
extends java.io.OutputStream
```
Buffered output stream that encapsulates another output stream. The implementation allows rollbacking of the buffered contents and writes the output to the encapsulated output stream only on explicit commit call. Committing of the contents is also done on close.
The buffered content is stored in the memory up to certain size; for larger amount of data file storage is used. NOTE: File storage not implemented yet!! TODO's: - test with the file based implementation of buffer - find an algorithm for setting buffer size. - use FndByteBufferOutputStream instead of ByteArrayOutputStream ( will require new method, e.g. flush(OutputStream) )

Constructor Summary

Constructors
Constructor and Description
`FndBufferedOutputStream(java.io.OutputStream out)` Create a new instance of this output stream and find a proper limit for how much memory should be used for temporary storage.
`FndBufferedOutputStream(java.io.OutputStream out, int maxSize)` Create a new instance of this output stream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this output stream and releases any system resources associated with this stream.
`void`	`commit()` Writes all the temporarily stored data to the encapsulated output stream.
`void`	`flush()` Flushes this output stream and forces any buffered output bytes to be written out.
`boolean`	`isClosed()` Checks if the stream has already been closed
`void`	`rollback()` Clears the temporarily stored data without writing it to the encapsulated output stream.
`java.lang.String`	`toString()` Creates string representation of this stream.
`void`	`write(byte[] b)` Writes `b.length` bytes from the specified byte array to this output stream.
`void`	`write(byte[] b, int off, int len)` Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
`void`	`write(int b)` Writes the specified byte to this output stream.

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

- Constructor Detail
  - FndBufferedOutputStream
```
public FndBufferedOutputStream(java.io.OutputStream out)
```
    Create a new instance of this output stream and find a proper limit for how much memory should be used for temporary storage.
    
    Parameters:
    
    out - the output stream to be encapsulated by this instance.
  - FndBufferedOutputStream
```
public FndBufferedOutputStream(java.io.OutputStream out,
                               int maxSize)
```
    Create a new instance of this output stream.
    
    Parameters:
    
    out - the output stream to be encapsulated by this instance.
    
    maxSize - limit in bytes of how much data should be stored in memory. Value of 0 mens unlimited, while -1 let the logic decide the proper value.
- Method Detail
  - write
```
public void write(int b)
           throws java.io.IOException
```
    Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.
    
    Specified by:
    
    write in class java.io.OutputStream
    
    Parameters:
    
    b - the byte.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.
  - write
```
public void write(byte[] b)
           throws java.io.IOException
```
    Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).
    
    Overrides:
    
    write in class java.io.OutputStream
    
    Parameters:
    
    b - the data.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
    
    See Also:
    
    OutputStream.write(byte[], int, int)
  - write
```
public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException
```
    Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.
    If b is null, a NullPointerException is thrown.
    If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.
    
    Overrides:
    
    write in class java.io.OutputStream
    
    Parameters:
    
    b - the data.
    
    off - the start offset in the data.
    
    len - the number of bytes to write.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.
  - flush
```
public void flush()
           throws java.io.IOException
```
    Flushes this output stream and forces any buffered output bytes to be written out. This method flushes only the temporary buffer not the encapsulated output stream, which is flushed first on commit or close.
    
    Specified by:
    
    flush in interface java.io.Flushable
    
    Overrides:
    
    flush in class java.io.OutputStream
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
  - close
```
public void close()
           throws java.io.IOException
```
    Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.
    This method will explicitly commit the data to the encapsulated output stream.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class java.io.OutputStream
    
    Throws:
    
    java.io.IOException - if an I/O error occurs or the stram has already been closed.
  - isClosed
```
public boolean isClosed()
```
    Checks if the stream has already been closed
    
    Returns:
    
    true if the stream has been closed
  - commit
```
public void commit()
            throws java.io.IOException
```
    Writes all the temporarily stored data to the encapsulated output stream. This method is explicitly called from close.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs or the stram has
  - rollback
```
public void rollback()
```
    Clears the temporarily stored data without writing it to the encapsulated output stream.
  - toString
```
public java.lang.String toString()
```
    Creates string representation of this stream.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    string representation of the stream

Class FndBufferedOutputStream

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FndBufferedOutputStream

FndBufferedOutputStream

Method Detail

write

write

write

flush

close

isClosed

commit

rollback

toString