TextWriter.Stream (OpenDJ Public API Javadoc 7.3.5-20240506155118-fba46f79e3510f00d8e7e5228e53672e49833f71 Documentation)

java.lang.Object
- org.forgerock.audit.events.handlers.writers.TextWriter.Stream

All Implemented Interfaces:

TextWriter

Enclosing interface:

TextWriter
```
public static class TextWriter.Stream
extends Object
implements TextWriter
```
A TextWriter implementation which writes to a given output stream.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.forgerock.audit.events.handlers.writers.TextWriter
  TextWriter.Stream

Constructor Summary

Constructors
Constructor Description

Stream(OutputStream outputStream)
Creates a new text writer that will write to the provided output stream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`flush()`	Flushes any buffered contents of the output stream.
`long`	`getBytesWritten()`	Retrieves the number of bytes written by this writer.
`void`	`shutdown()`	Releases any resources held by the writer.
`void`	`write(String text)`	Writes some text to the output stream.

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

- Constructor Detail
  - Stream
```
public Stream(OutputStream outputStream)
```
    Creates a new text writer that will write to the provided output stream.
    
    Parameters:
    
    outputStream - The output stream to which
- Method Detail
  - write
```
public void write(String text)
```
    Description copied from interface: TextWriter
    
    Writes some text to the output stream.
    
    Specified by:
    
    write in interface TextWriter
    
    Parameters:
    
    text - The text to write
  - flush
```
public void flush()
```
    Description copied from interface: TextWriter
    
    Flushes any buffered contents of the output stream.
    
    Specified by:
    
    flush in interface TextWriter
  - shutdown
```
public void shutdown()
```
    Description copied from interface: TextWriter
    
    Releases any resources held by the writer.
    
    Specified by:
    
    shutdown in interface TextWriter
  - getBytesWritten
```
public long getBytesWritten()
```
    Description copied from interface: TextWriter
    
    Retrieves the number of bytes written by this writer.
    
    Specified by:
    
    getBytesWritten in interface TextWriter
    
    Returns:
    
    the number of bytes written by this writer.