Class WritableFile

java.lang.Object
java.io.File
org.codehaus.groovy.runtime.WritableFile
All Implemented Interfaces:
Writable, Serializable, Comparable<File>

public class WritableFile
extends File
implements Writable
A Writable File.
See Also:
Serialized Form
  • Constructor Details

    • WritableFile

      public WritableFile​(File delegate)
    • WritableFile

      public WritableFile​(File delegate, String encoding)
  • Method Details

    • writeTo

      public Writer writeTo​(Writer out) throws IOException
      Description copied from interface: Writable
      Writes this object to the given writer.

      This is used to defer content creation until the point when it is streamed to the output destination. Oftentimes, content will be defined but not necessarily created (as is may be the case with a Closure definition.) In that case, the output is then 'deferred' to the point when it is serialized to the writer. This class may be used whenever an object should be responsible for creating its own textual representation, but creating the entire output as a single String would be inefficient (such as outputting a multi-gigabyte XML document.)

      Specified by:
      writeTo in interface Writable
      Parameters:
      out - the Writer to which this Writable should output its data.
      Returns:
      the Writer that was passed
      Throws:
      IOException - if an error occurred while outputting data to the writer