Package org.springframework.batch.item.util

# Class FileUtils

java.lang.Object
org.springframework.batch.item.util.FileUtils

public final class FileUtils extends Object
Utility methods for files used in batch processing.

Author:
  Peter Zozom, Mahmoud Ben Hassine

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static boolean`
  `createNewFile(File file)`
  Create a new file if it doesn't already exist.
  `static void`
  `setUpOutputFile(File file, boolean restarted, boolean append, boolean overwriteOutputFile)`
  Set up output file for batch processing.

  ### Methods inherited from class java.lang.Object

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

- ## Method Details

  - ### setUpOutputFile

    public static void setUpOutputFile(File file, boolean restarted, boolean append, boolean overwriteOutputFile)
    Set up output file for batch processing. This method implements common logic for handling output files when starting or restarting file I/O. When starting output file processing, creates/overwrites new file. When restarting output file processing, checks whether file is writable.
    Parameters:
      `file` - file to be set up
      `restarted` - true signals that we are restarting output file processing
      `append` - true signals input file may already exist (but doesn't have to)
      `overwriteOutputFile` - If set to true, output file will be overwritten (this flag is ignored when processing is restart)

  - ### createNewFile

    public static boolean createNewFile(File file) throws IOException
    Create a new file if it doesn't already exist.
    Parameters:
      `file` - the file to create on the filesystem
    Returns:
      true if file was created else false.
    Throws:
      `IOException` - is thrown if error occurs during creation and file does not exist.