Module eu.steffo.cleaver

Package eu.steffo.cleaver.logic.split

Class SplitFileOutputStream

java.lang.Object

java.io.OutputStream

eu.steffo.cleaver.logic.split.SplitFileOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class SplitFileOutputStream
extends OutputStream

A custom OutputStream that writes the bytes received in input in multiple files with a progressively increasing number (.c1, .c2, .c3, and so on). Bytes are written to a file until its length reaches maximumByteCount, then the program switches to the following file (.c2 if .c1 is full, .c3 if .c2 is full, and so on).

Field Summary

Fields

Modifier and Type	Field	Description
private long	currentByteCount
private int	currentFileCount
protected FileOutputStream	currentFileOutputStream	The FileOutputStream this OutputStream is currently writing to.
private String	fileBaseName
private long	maximumByteCount

Constructor Summary

Constructors

Constructor	Description
SplitFileOutputStream(String fileBaseName, long maximumByteCount)

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	createNextFileOutputStream()	Create the following file in the sequence, and update the currentFileOutputStream.
long	getCurrentByteCount()
int	getCurrentFileCount()
String	getFileBaseName()
long	getMaximumByteCount()
void	write(int b)

Methods inherited from class java.io.OutputStream

flush, nullOutputStream, write, write

Methods inherited from class java.lang.Object

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

Field Details

fileBaseName

private final String fileBaseName

currentByteCount

private long currentByteCount

maximumByteCount

private long maximumByteCount

currentFileCount

private int currentFileCount

currentFileOutputStream

protected FileOutputStream currentFileOutputStream

The FileOutputStream this OutputStream is currently writing to.

Constructor Details

SplitFileOutputStream

public SplitFileOutputStream(String fileBaseName, long maximumByteCount)

Parameters:

fileBaseName - The name that the files without the extension. If it is example, the created files will be example.c1, example.c2, and so on.

maximumByteCount - The number of bytes that should be written to a file before switching to the next one.

Method Details

createNextFileOutputStream

protected void createNextFileOutputStream() throws IOException

Create the following file in the sequence, and update the currentFileOutputStream.

Throws:

IOException - If for some reason the program cannot create the file.

write

public void write(int b) throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

close

public void close() throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

getFileBaseName

public String getFileBaseName()

Returns:

The name that the files without the extension. If it is example, the created files will be example.c1, example.c2, and so on.

getCurrentByteCount

public long getCurrentByteCount()

Returns:

The number of bytes that have already been written to the current file.

getMaximumByteCount

public long getMaximumByteCount()

Returns:

The number of bytes that should be written to a file before switching to the next one.

getCurrentFileCount

public int getCurrentFileCount()

Returns:

The number of files that have already been created.