Class AbstractFileItemWriter.OutputState

java.lang.Object
org.springframework.batch.item.support.AbstractFileItemWriter.OutputState
Enclosing class:
AbstractFileItemWriter<T>

protected class AbstractFileItemWriter.OutputState extends Object
Encapsulates the runtime state of the writer. All state changing operations on the writer go through this class.
  • Constructor Details

    • OutputState

      protected OutputState()
  • Method Details

    • position

      public long position() throws IOException
      Return the byte offset position of the cursor in the output file as a long integer.
      Returns:
      the byte offset position of the cursor in the output file
      Throws:
      IOException - If unable to get the offset position
    • setAppendAllowed

      public void setAppendAllowed(boolean append)
      Parameters:
      append - if true, append to previously created file
    • restoreFrom

      public void restoreFrom(ExecutionContext executionContext)
      Parameters:
      executionContext - state from which to restore writing from
    • setDeleteIfExists

      public void setDeleteIfExists(boolean shouldDeleteIfExists)
      Parameters:
      shouldDeleteIfExists - indicator
    • setEncoding

      public void setEncoding(String encoding)
      Parameters:
      encoding - file encoding
    • getLinesWritten

      public long getLinesWritten()
    • setLinesWritten

      public void setLinesWritten(long linesWritten)
    • close

      public void close()
      Close the open resource and reset counters.
    • write

      public void write(String line) throws IOException
      Parameters:
      line - String to be written to the file
      Throws:
      IOException - If unable to write the String to the file
    • truncate

      public void truncate() throws IOException
      Truncate the output at the last known good point.
      Throws:
      IOException - if unable to work with file
    • isInitialized

      public boolean isInitialized()