org.myire.munge.transform

Class OutputFileSpec

java.lang.Object

org.myire.munge.transform.OutputFileSpec

public class OutputFileSpec
extends java.lang.Object

An OutputFileSpec associates a File with a set of OpenOption to use when opening the file for writing.

Constructor Summary

Constructors

Constructor and Description
OutputFileSpec(java.io.File pFile, java.nio.file.OpenOption... pOpenOptions) Create a new OutputFileSpec.

Method Summary

Modifier and Type	Method and Description
java.io.File	getFile() Get the file that will be opened in calls to open().
java.io.OutputStream	open() Open the file for writing with the options specified in the constructor.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputFileSpec

public OutputFileSpec(java.io.File pFile,
                      java.nio.file.OpenOption... pOpenOptions)

Create a new OutputFileSpec.

Parameters:

pFile - The file specification.

pOpenOptions - The options to specify when opening the file for writing.

Throws:

java.lang.NullPointerException - if any of the parameters is null.

Method Detail

getFile

public java.io.File getFile()

Get the file that will be opened in calls to open().

Returns:

The underlying File, never null.

open

public java.io.OutputStream open()
                          throws java.io.IOException

Open the file for writing with the options specified in the constructor. Any parent directories that don't exist will be created first.

Returns:

An OutputStream for the opened file. The caller is responsible for closing this stream.

Throws:

java.io.IOException - if opening the file or creating a parent directory fails.