Package com.helger.io.stream

Class CountingFileOutputStream

java.lang.Object

java.io.OutputStream

java.io.FileOutputStream

com.helger.io.stream.CountingFileOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class CountingFileOutputStream
extends FileOutputStream

A special FileOutputStream sub class that keeps track of all written bytes for the statistics handler.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final com.helger.base.io.EAppend	DEFAULT_APPEND	By default append is enabled

Constructor Summary

Constructors

Constructor	Description
CountingFileOutputStream(@NonNull File aFile)	Constructor using the default append mode.
CountingFileOutputStream(@NonNull File aFile, @NonNull com.helger.base.io.EAppend eAppend)	Constructor with explicit append mode.
CountingFileOutputStream(@NonNull String sFilename)	Constructor using the default append mode.
CountingFileOutputStream(@NonNull String sFilename, @NonNull com.helger.base.io.EAppend eAppend)	Constructor with explicit append mode.

Method Summary

Modifier and Type	Method	Description
long	getBytesWritten()
String	toString()
void	write(byte[] b)
void	write(byte[] b, int nOffset, int nLength)
void	write(int b)

Methods inherited from class java.io.FileOutputStream

close, getChannel, getFD

Methods inherited from class java.io.OutputStream

flush, nullOutputStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_APPEND

public static final com.helger.base.io.EAppend DEFAULT_APPEND

By default append is enabled

Constructor Details

CountingFileOutputStream

public CountingFileOutputStream(@NonNull File aFile)
                         throws FileNotFoundException

Constructor using the default append mode.

Parameters:

aFile - The file to write to. May not be null.

Throws:

FileNotFoundException - If the file cannot be opened for writing.

CountingFileOutputStream

public CountingFileOutputStream(@NonNull File aFile,
 @NonNull com.helger.base.io.EAppend eAppend)
                         throws FileNotFoundException

Constructor with explicit append mode.

Parameters:

aFile - The file to write to. May not be null.

eAppend - Appending mode. May not be null.

Throws:

FileNotFoundException - If the file cannot be opened for writing.

CountingFileOutputStream

public CountingFileOutputStream(@NonNull String sFilename)
                         throws FileNotFoundException

Constructor using the default append mode.

Parameters:

sFilename - The filename to write to. May not be null.

Throws:

FileNotFoundException - If the file cannot be opened for writing.

CountingFileOutputStream

public CountingFileOutputStream(@NonNull String sFilename,
 @NonNull com.helger.base.io.EAppend eAppend)
                         throws FileNotFoundException

Constructor with explicit append mode.

Parameters:

sFilename - The filename to write to. May not be null.

eAppend - Appending mode. May not be null.

Throws:

FileNotFoundException - If the file cannot be opened for writing.

Method Details

write

public void write(int b)
           throws IOException

Overrides:

write in class FileOutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class FileOutputStream

Throws:

IOException

write

public void write(byte[] b,
 int nOffset,
 int nLength)
           throws IOException

Overrides:

write in class FileOutputStream

Throws:

IOException

getBytesWritten

@Nonnegative
public long getBytesWritten()

Returns:

The number of bytes written so far. Always ≥ 0.

toString

public String toString()

Overrides:

toString in class Object