org.sejda.core.support.io.model

Class FileOutput

java.lang.Object

org.sejda.core.support.io.model.FileOutput

All Implemented Interfaces:

OngoingFileOuputCreation, PopulatedFileOutput

public final class FileOutput
extends Object
implements OngoingFileOuputCreation, PopulatedFileOutput

Holds informations about an output file generated by a task. When fully populated holds a reference to the temporary file created by the task and information about the new name for the temporary file. Usage:

 {
     PopulatedFileOutput out = file(tmpFile).name(outName);
 }
 

Author:

Andrea Vacondio

Method Summary

Methods

Modifier and Type	Method and Description
static OngoingFileOuputCreation	file(File file) Entry point to populate the FileOutput
File	getFile()
String	getName()
PopulatedFileOutput	name(String name) set the name for the current instance

Methods inherited from class java.lang.Object

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

Method Detail

file

public static OngoingFileOuputCreation file(File file)

Entry point to populate the FileOutput

Parameters:

file -

Returns:

the not fully populated instance

getFile

public File getFile()

Specified by:

getFile in interface PopulatedFileOutput

Returns:

the temporary file

getName

public String getName()

Specified by:

getName in interface PopulatedFileOutput

Returns:

the new name

name

public PopulatedFileOutput name(String name)

Description copied from interface: OngoingFileOuputCreation

set the name for the current instance

Specified by:

name in interface OngoingFileOuputCreation

Returns:

the fully populated File output.