com.github.akurilov.commons.io.file.BinFileOutput Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of java-commons Show documentation

Common functionality Java library

There is a newer version: 2.3.6

package com.github.akurilov.commons.io.file;

import com.github.akurilov.commons.io.BinOutput;

import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.ObjectOutputStream;
import java.nio.file.Files;
import java.nio.file.Path;

/**
 * An item input implementation serializing something to the specified file.
 * WARNING: doesn't support the appending of the previously used output file (already
 * containing the data which had been output earlier). This limitation is due to Java serialization,
 * which adds the new header on each new ObjectOutputStream instance.
 */
public class BinFileOutput
extends BinOutput
implements FileOutput {
	
	protected final Path dstPath;

	/**
	 @param dstPath the path to the file which should be used to store the serialized items
	 @throws IOException if unable to open the file for writing
	 */
	public BinFileOutput(final Path dstPath)
	throws IOException {
		super(
			new ObjectOutputStream(
				new BufferedOutputStream(Files.newOutputStream(dstPath, OUTPUT_OPEN_OPTIONS))
			)
		);
		this.dstPath = dstPath;
	}

	/**
	 * Opens the temporary output file with ".bin" extension and random name.
	 */
	public BinFileOutput()
	throws IOException {
		this(Files.createTempFile(null, ".bin"));
		this.dstPath.toFile().deleteOnExit();
	}
	
	@Override
	public BinFileInput getInput()
	throws IOException {
		return new BinFileInput<>(dstPath);
	}
	
	@Override
	public String toString() {
		return "binFileOutput<" + dstPath.getFileName() + ">";
	}
	
	@Override
	public final Path getFilePath() {
		return dstPath;
	}
}