BufferOutputStream (Net4j Signalling Platform Documentation)

java.lang.Object
- java.io.OutputStream
- - org.eclipse.net4j.buffer.BufferOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

ChannelOutputStream
```
public class BufferOutputStream
extends OutputStream
```
An output stream that fragments the written byte sequence into fixed-sized buffers and passes them to configured buffer handler.

Author:

Eike Stepper

Field Summary

Fields
Modifier and Type Field and Description

static boolean DEFAULT_PROPAGATE_CLOSE

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_PROPAGATE_CLOSE`

Constructor Summary

Constructors
Constructor and Description
`BufferOutputStream(IBufferHandler bufferHandler, IBufferProvider bufferProvider, short channelID)`
`BufferOutputStream(IBufferHandler bufferHandler, short channelID)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`protected void`	`ensureBuffer()` Ensures that this BufferOutputStream has a buffer.
`void`	`flush()` Flushes the current buffer, it's handled over to the buffer handler.
`void`	`flushWithEOS()`
`void`	`flushWithEOS(boolean ccam)`
`Throwable`	`getError()`
`protected boolean`	`isPropagateClose()`
`void`	`setError(Throwable error)`
`String`	`toString()`
`void`	`write(int b)`

Methods inherited from class java.io.OutputStream
write, write

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

- Field Detail
  - DEFAULT_PROPAGATE_CLOSE
```
public static final boolean DEFAULT_PROPAGATE_CLOSE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BufferOutputStream
```
public BufferOutputStream(IBufferHandler bufferHandler,
                          IBufferProvider bufferProvider,
                          short channelID)
```
  - BufferOutputStream
```
public BufferOutputStream(IBufferHandler bufferHandler,
                          short channelID)
```
- Method Detail
  - getError
```
public Throwable getError()
```
    Since:
    
    2.0
  - setError
```
public void setError(Throwable error)
```
    Since:
    
    2.0
  - write
```
public void write(int b)
           throws IOException
```
    Specified by:
    
    write in class OutputStream
    
    Throws:
    
    IOException
  - flush
```
public void flush()
           throws IOException
```
    Flushes the current buffer, it's handled over to the buffer handler.
    
    Specified by:
    
    flush in interface Flushable
    
    Overrides:
    
    flush in class OutputStream
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
    
    See Also:
    
    currentBuffer, IBufferHandler.handleBuffer(IBuffer)
  - flushWithEOS
```
public void flushWithEOS()
                  throws IOException
```
    Throws:
    
    IOException
  - flushWithEOS
```
public void flushWithEOS(boolean ccam)
                  throws IOException
```
    Throws:
    
    IOException
    
    Since:
    
    4.4
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class OutputStream
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - ensureBuffer
```
protected void ensureBuffer()
                     throws IOException
```
    Ensures that this BufferOutputStream has a buffer. If the current buffer was flushed a new one is fetched from the buffer provider.
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
    
    See Also:
    
    flush(), IBufferProvider.provideBuffer()
  - isPropagateClose
```
protected boolean isPropagateClose()
```

Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html

Class BufferOutputStream

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.io.OutputStream

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PROPAGATE_CLOSE

Constructor Detail

BufferOutputStream

BufferOutputStream

Method Detail

getError

setError

write

flush

flushWithEOS

flushWithEOS

close

toString

ensureBuffer

isPropagateClose