NioGroovyMethods (Groovy 2.3.2)

java.lang.Object
- org.codehaus.groovy.runtime.DefaultGroovyMethodsSupport
- - org.codehaus.groovy.runtime.NioGroovyMethods

```
public class NioGroovyMethods
extends DefaultGroovyMethodsSupport
```
This class defines new groovy methods for Readers, Writers, InputStreams and OutputStreams which appear on normal JDK classes inside the Groovy environment. Static methods are used with the first parameter being the destination class, i.e. public static T eachLine(InputStream self, Closure c) provides a eachLine(Closure c) method for InputStream.
NOTE: While this class contains many 'public' static methods, it is primarily regarded as an internal class (its internal package name suggests this also). We value backwards compatibility of these methods when used within Groovy but value less backwards compatibility at the Java method call level. I.e. future versions of Groovy may remove or move a method call in this file but would normally aim to keep the method available from within Groovy.

Author:

James Strachan, Jeremy Rayner, Sam Pullara, Rod Cope, Guillaume Laforge, John Wilson, Hein Meling, Dierk Koenig, Pilho Kim, Marc Guillemot, Russel Winder, bing ran, Jochen Theodorou, Paul King, Michael Baehr, Joachim Baumann, Alex Tkachman, Ted Naleid, Brad Long, Jim Jagielski, Rodolfo Velasco, jeremi Joslin, Hamlet D'Arcy, Cedric Champeau, Tim Yates, Dinko Srkoc, Paolo Di Tommaso

Constructor Summary

Constructors
Constructor and Description

NioGroovyMethods()

Constructors
Constructor and Description
`NioGroovyMethods()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`append(Path self, byte[] bytes)` Append bytes to the end of a Path.
`static void`	`append(Path self, InputStream stream)` Append binary data to the file.
`static void`	`append(Path self, Object text)` Append the text at the end of the Path.
`static void`	`append(Path self, Object text, String charset)` Append the text at the end of the Path, using a specified encoding.
`static void`	`append(Path file, Reader reader)` Append the text supplied by the Writer at the end of the File.
`static void`	`append(Path file, Reader reader, String charset)` Append the text supplied by the Reader at the end of the File, using a specified encoding.
`static void`	`append(Path file, Writer writer)` Append the text supplied by the Writer at the end of the File.
`static void`	`append(Path file, Writer writer, String charset)` Append the text supplied by the Writer at the end of the File, using a specified encoding.
`static <T> T`	`asType(Path path, Class<T> c)` Converts this Path to a `Writable` or delegates to default `DefaultGroovyMethods.asType(Object, Class)`.
`static Path`	`asWritable(Path self)` Converts this Path to a `Writable`.
`static Path`	`asWritable(Path self, String encoding)` Allows a file to return a Writable implementation that can output itself to a Writer stream.
`static boolean`	`deleteDir(Path self)` Deletes a directory with all contained files and subdirectories.
`static void`	`eachByte(Path self, Closure closure)` Traverse through each byte of this Path
`static void`	`eachByte(Path self, int bufferLen, Closure closure)` Traverse through the bytes of this Path, bufferLen bytes at a time.
`static void`	`eachDir(Path self, Closure closure)` Invokes the closure for each subdirectory in this directory, ignoring regular files.
`static void`	`eachDirMatch(Path self, Object nameFilter, Closure closure)` Invokes the closure for each subdirectory whose name (dir.name) matches the given nameFilter in the given directory - calling the `DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object)` method to determine if a match occurs.
`static void`	`eachDirRecurse(Path self, Closure closure)` Invokes the closure for each descendant directory of this directory.
`static void`	`eachFile(Path self, Closure closure)` Invokes the closure for each 'child' file in this 'parent' folder/directory.
`static void`	`eachFile(Path self, FileType fileType, Closure closure)` Invokes the closure for each 'child' file in this 'parent' folder/directory.
`static void`	`eachFileMatch(Path self, FileType fileType, Object nameFilter, Closure closure)` Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory - calling the `DefaultGroovyMethods.isCase(Object, Object)` method to determine if a match occurs.
`static void`	`eachFileMatch(Path self, Object nameFilter, Closure closure)` Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory - calling the `DefaultGroovyMethods.isCase(Object, Object)` method to determine if a match occurs.
`static void`	`eachFileRecurse(Path self, Closure closure)` Invokes the closure for each descendant file in this directory.
`static void`	`eachFileRecurse(Path self, FileType fileType, Closure closure)` Invokes the closure for each descendant file in this directory.
`static <T> T`	`eachLine(Path self, Closure<T> closure)` Iterates through this path line by line.
`static <T> T`	`eachLine(Path self, int firstLine, Closure<T> closure)` Iterates through this file line by line.
`static <T> T`	`eachLine(Path self, String charset, Closure<T> closure)` Iterates through this file line by line.
`static <T> T`	`eachLine(Path self, String charset, int firstLine, Closure<T> closure)` Iterates through this file line by line.
`static void`	`eachObject(Path self, Closure closure)` Iterates through the given file object by object.
`static Writable`	`filterLine(Path self, Closure closure)` Filters the lines of a Path and creates a Writable in return to stream the filtered lines.
`static Writable`	`filterLine(Path self, String charset, Closure closure)` Filters the lines of a Path and creates a Writable in return to stream the filtered lines.
`static void`	`filterLine(Path self, Writer writer, Closure closure)` Filter the lines from this Path, and write them to the given writer based on the given closure predicate.
`static void`	`filterLine(Path self, Writer writer, String charset, Closure closure)` Filter the lines from this Path, and write them to the given writer based on the given closure predicate.
`static byte[]`	`getBytes(Path self)` Read the content of the Path and returns it as a byte[].
`static String`	`getText(Path self)` Read the content of the Path and returns it as a String.
`static String`	`getText(Path self, String charset)` Read the content of the Path using the specified encoding and return it as a String.
`static Path`	`leftShift(Path self, byte[] bytes)` Write bytes to a Path.
`static Path`	`leftShift(Path path, InputStream data)` Append binary data to the file.
`static Path`	`leftShift(Path self, Object text)` Write the text to the Path.
`static DataInputStream`	`newDataInputStream(Path self)` Create a data input stream for this file
`static DataOutputStream`	`newDataOutputStream(Path self)` Creates a new data output stream for this file.
`static BufferedInputStream`	`newInputStream(Path self)` Creates a buffered input stream for this file.
`static ObjectInputStream`	`newObjectInputStream(Path self)` Create an object input stream for this file.
`static ObjectInputStream`	`newObjectInputStream(Path self, ClassLoader classLoader)` Create an object input stream for this path using the given class loader.
`static ObjectOutputStream`	`newObjectOutputStream(Path self)` Create an object output stream for this path.
`static BufferedOutputStream`	`newOutputStream(Path self)` Create a buffered output stream for this file.
`static PrintWriter`	`newPrintWriter(Path self)` Create a new PrintWriter for this file.
`static PrintWriter`	`newPrintWriter(Path self, String charset)` Create a new PrintWriter for this file, using specified charset.
`static BufferedReader`	`newReader(Path self)` Create a buffered reader for this file.
`static BufferedReader`	`newReader(Path self, String charset)` Create a buffered reader for this file, using the specified charset as the encoding.
`static BufferedWriter`	`newWriter(Path self)` Create a buffered writer for this file.
`static BufferedWriter`	`newWriter(Path self, boolean append)` Creates a buffered writer for this file, optionally appending to the existing file content.
`static BufferedWriter`	`newWriter(Path self, String charset)` Creates a buffered writer for this file, writing data using the given encoding.
`static BufferedWriter`	`newWriter(Path self, String charset, boolean append)` Helper method to create a buffered writer for a file.
`static byte[]`	`readBytes(Path self)` Reads the content of the file into a byte array.
`static List<String>`	`readLines(Path self)` Reads the file into a list of Strings, with one item for each line.
`static List<String>`	`readLines(Path self, String charset)` Reads the file into a list of Strings, with one item for each line.
`static boolean`	`renameTo(Path self, String newPathName)` Renames a file.
`static boolean`	`renameTo(Path self, URI newPathName)` Renames a file.
`static void`	`setBytes(Path self, byte[] bytes)` Write the bytes from the byte array to the Path.
`static void`	`setText(Path self, String text)` Synonym for write(text) allowing file.text = 'foo'.
`static void`	`setText(Path self, String text, String charset)` Synonym for write(text, charset) allowing:
`static long`	`size(Path self)` Provide the standard Groovy `size()` method for `Path`.
`static <T> T`	`splitEachLine(Path self, Pattern pattern, Closure<T> closure)` Iterates through this file line by line, splitting each line using the given separator Pattern.
`static <T> T`	`splitEachLine(Path self, Pattern pattern, String charset, Closure<T> closure)` Iterates through this file line by line, splitting each line using the given regex separator Pattern.
`static <T> T`	`splitEachLine(Path self, String regex, Closure<T> closure)` Iterates through this file line by line, splitting each line using the given regex separator.
`static <T> T`	`splitEachLine(Path self, String regex, String charset, Closure<T> closure)` Iterates through this file line by line, splitting each line using the given regex separator.
`static void`	`traverse(Path self, Closure closure)` Invokes the closure for each descendant file in this directory tree.
`static void`	`traverse(Path self, Map<String,Object> options)` Invokes the closure specified with key 'visit' in the options Map for each descendant file in this directory tree.
`static void`	`traverse(Path self, Map<String,Object> options, Closure closure)` Invokes `closure` for each descendant file in this directory tree.
`static <T> T`	`withCloseable(Closeable self, Closure<T> action)` Allows this closeable to be used within the closure, ensuring that it is closed once the closure has been executed and before this method returns.
`static <T> T`	`withDataInputStream(Path self, Closure<T> closure)` Create a new DataInputStream for this file and passes it into the closure.
`static <T> T`	`withDataOutputStream(Path self, Closure<T> closure)` Create a new DataOutputStream for this file and passes it into the closure.
`static Object`	`withInputStream(Path self, Closure closure)` Create a new InputStream for this file and passes it into the closure.
`static <T> T`	`withObjectInputStream(Path self, ClassLoader classLoader, Closure<T> closure)` Create a new ObjectInputStream for this file associated with the given class loader and pass it to the closure.
`static <T> T`	`withObjectInputStream(Path path, Closure<T> closure)` Create a new ObjectInputStream for this file and pass it to the closure.
`static <T> T`	`withObjectOutputStream(Path self, Closure<T> closure)` Create a new ObjectOutputStream for this path and then pass it to the closure.
`static Object`	`withOutputStream(Path self, Closure closure)` Creates a new OutputStream for this file and passes it into the closure.
`static <T> T`	`withPrintWriter(Path self, Closure<T> closure)` Create a new PrintWriter for this file which is then passed it into the given closure.
`static <T> T`	`withPrintWriter(Path self, String charset, Closure<T> closure)` Create a new PrintWriter with a specified charset for this file.
`static <T> T`	`withReader(Path self, Closure<T> closure)` Create a new BufferedReader for this file and then passes it into the closure, ensuring the reader is closed after the closure returns.
`static <T> T`	`withReader(Path self, String charset, Closure<T> closure)` Create a new BufferedReader for this file using the specified charset and then passes it into the closure, ensuring the reader is closed after the closure returns.
`static <T> T`	`withWriter(Path self, Closure<T> closure)` Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns.
`static <T> T`	`withWriter(Path self, String charset, Closure<T> closure)` Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns.
`static <T> T`	`withWriterAppend(Path self, Closure<T> closure)` Create a new BufferedWriter for this file in append mode.
`static <T> T`	`withWriterAppend(Path self, String charset, Closure<T> closure)` Create a new BufferedWriter which will append to this file.
`static void`	`write(Path self, String text)` Write the text to the Path.
`static void`	`write(Path self, String text, String charset)` Write the text to the Path, using the specified encoding.

Methods inherited from class org.codehaus.groovy.runtime.DefaultGroovyMethodsSupport
cloneSimilarCollection, cloneSimilarMap, closeQuietly, closeWithWarning, createSimilarArray, createSimilarCollection, createSimilarCollection, createSimilarList, createSimilarMap, createSimilarOrDefaultCollection, createSimilarSet, normaliseIndex, sameType, subListBorders, subListBorders

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NioGroovyMethods
```
public NioGroovyMethods()
```
- Method Detail
  - size
```
public static long size(Path self)
                 throws IOException
```
    Provide the standard Groovy size() method for Path.
    
    Parameters:
    self - a Path object
    
    Returns:
    the file's size (length)
    
    Throws:
    
    IOException
    Since:
    
    2.3.0
  - newObjectOutputStream
```
public static ObjectOutputStream newObjectOutputStream(Path self)
                                                throws IOException
```
    Create an object output stream for this path.
    
    Parameters:
    self - a Path object
    
    Returns:
    an object output stream
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - withObjectOutputStream
```
public static <T> T withObjectOutputStream(Path self,
                           Closure<T> closure)
                                throws IOException
```
    Create a new ObjectOutputStream for this path and then pass it to the closure. This method ensures the stream is closed after the closure returns.
    
    Parameters:
    self - a Path
    closure - a closure
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.withStream(java.io.OutputStream, groovy.lang.Closure)
  - newObjectInputStream
```
public static ObjectInputStream newObjectInputStream(Path self)
                                              throws IOException
```
    Create an object input stream for this file.
    
    Parameters:
    self - a Path object
    
    Returns:
    an object input stream
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - newObjectInputStream
```
public static ObjectInputStream newObjectInputStream(Path self,
                                     ClassLoader classLoader)
                                              throws IOException
```
    Create an object input stream for this path using the given class loader.
    
    Parameters:
    self - a Path object
    classLoader - the class loader to use when loading the class
    
    Returns:
    an object input stream
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - eachObject
```
public static void eachObject(Path self,
              Closure closure)
                       throws IOException,
                              ClassNotFoundException
```
    Iterates through the given file object by object.
    
    Parameters:
    self - a Path object
    closure - a closure
    
    Throws:
    
    IOException - if an IOException occurs.
    
    ClassNotFoundException - if the class is not found.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.eachObject(java.io.ObjectInputStream, groovy.lang.Closure)
  - withObjectInputStream
```
public static <T> T withObjectInputStream(Path path,
                          Closure<T> closure)
                               throws IOException
```
    Create a new ObjectInputStream for this file and pass it to the closure. This method ensures the stream is closed after the closure returns.
    
    Parameters:
    path - a Path
    closure - a closure
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.withStream(java.io.InputStream, groovy.lang.Closure)
  - withObjectInputStream
```
public static <T> T withObjectInputStream(Path self,
                          ClassLoader classLoader,
                          Closure<T> closure)
                               throws IOException
```
    Create a new ObjectInputStream for this file associated with the given class loader and pass it to the closure. This method ensures the stream is closed after the closure returns.
    
    Parameters:
    self - a Path
    classLoader - the class loader to use when loading the class
    closure - a closure
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.withStream(java.io.InputStream, groovy.lang.Closure)
  - eachLine
```
public static <T> T eachLine(Path self,
             Closure<T> closure)
                  throws IOException
```
    Iterates through this path line by line. Each line is passed to the given 1 or 2 arg closure. The file is read using a reader which is closed before this method returns.
    
    Parameters:
    self - a Path
    closure - a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
    
    Returns:
    the last value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    eachLine(Path, int, groovy.lang.Closure)
  - eachLine
```
public static <T> T eachLine(Path self,
             String charset,
             Closure<T> closure)
                  throws IOException
```
    Iterates through this file line by line. Each line is passed to the given 1 or 2 arg closure. The file is read using a reader which is closed before this method returns.
    
    Parameters:
    self - a Path
    charset - opens the file with a specified charset
    closure - a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
    
    Returns:
    the last value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    eachLine(Path, String, int, groovy.lang.Closure)
  - eachLine
```
public static <T> T eachLine(Path self,
             int firstLine,
             Closure<T> closure)
                  throws IOException
```
    Iterates through this file line by line. Each line is passed to the given 1 or 2 arg closure. The file is read using a reader which is closed before this method returns.
    
    Parameters:
    self - a Path
    firstLine - the line number value used for the first line (default is 1, set to 0 to start counting from 0)
    closure - a closure (arg 1 is line, optional arg 2 is line number)
    
    Returns:
    the last value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.eachLine(java.io.Reader, int, groovy.lang.Closure)
  - eachLine
```
public static <T> T eachLine(Path self,
             String charset,
             int firstLine,
             Closure<T> closure)
                  throws IOException
```
    Iterates through this file line by line. Each line is passed to the given 1 or 2 arg closure. The file is read using a reader which is closed before this method returns.
    
    Parameters:
    self - a Path
    charset - opens the file with a specified charset
    firstLine - the line number value used for the first line (default is 1, set to 0 to start counting from 0)
    closure - a closure (arg 1 is line, optional arg 2 is line number)
    
    Returns:
    the last value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.eachLine(java.io.Reader, int, groovy.lang.Closure)
  - splitEachLine
```
public static <T> T splitEachLine(Path self,
                  String regex,
                  Closure<T> closure)
                       throws IOException
```
    Iterates through this file line by line, splitting each line using the given regex separator. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. Finally the resources used for processing the file are closed.
    
    Parameters:
    self - a Path
    regex - the delimiting regular expression
    closure - a closure
    
    Returns:
    the last value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    
    PatternSyntaxException - if the regular expression's syntax is invalid
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.splitEachLine(java.io.Reader, String, groovy.lang.Closure)
  - splitEachLine
```
public static <T> T splitEachLine(Path self,
                  Pattern pattern,
                  Closure<T> closure)
                       throws IOException
```
    Iterates through this file line by line, splitting each line using the given separator Pattern. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression Pattern. Finally the resources used for processing the file are closed.
    
    Parameters:
    self - a Path
    pattern - the regular expression Pattern for the delimiter
    closure - a closure
    
    Returns:
    the last value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.splitEachLine(java.io.Reader, java.util.regex.Pattern, groovy.lang.Closure)
  - splitEachLine
```
public static <T> T splitEachLine(Path self,
                  String regex,
                  String charset,
                  Closure<T> closure)
                       throws IOException
```
    Iterates through this file line by line, splitting each line using the given regex separator. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. Finally the resources used for processing the file are closed.
    
    Parameters:
    self - a Path
    regex - the delimiting regular expression
    charset - opens the file with a specified charset
    closure - a closure
    
    Returns:
    the last value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    
    PatternSyntaxException - if the regular expression's syntax is invalid
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.splitEachLine(java.io.Reader, String, groovy.lang.Closure)
  - splitEachLine
```
public static <T> T splitEachLine(Path self,
                  Pattern pattern,
                  String charset,
                  Closure<T> closure)
                       throws IOException
```
    Iterates through this file line by line, splitting each line using the given regex separator Pattern. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. Finally the resources used for processing the file are closed.
    
    Parameters:
    self - a Path
    pattern - the regular expression Pattern for the delimiter
    charset - opens the file with a specified charset
    closure - a closure
    
    Returns:
    the last value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.splitEachLine(java.io.Reader, java.util.regex.Pattern, groovy.lang.Closure)
  - readLines
```
public static List<String> readLines(Path self)
                              throws IOException
```
    Reads the file into a list of Strings, with one item for each line.
    
    Parameters:
    self - a Path
    
    Returns:
    a List of lines
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.readLines(java.io.Reader)
  - readLines
```
public static List<String> readLines(Path self,
                     String charset)
                              throws IOException
```
    Reads the file into a list of Strings, with one item for each line.
    
    Parameters:
    self - a Path
    charset - opens the file with a specified charset
    
    Returns:
    a List of lines
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.readLines(java.io.Reader)
  - getText
```
public static String getText(Path self,
             String charset)
                      throws IOException
```
    Read the content of the Path using the specified encoding and return it as a String.
    
    Parameters:
    self - the file whose content we want to read
    charset - the charset used to read the content of the file
    
    Returns:
    a String containing the content of the file
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - getText
```
public static String getText(Path self)
                      throws IOException
```
    Read the content of the Path and returns it as a String.
    
    Parameters:
    self - the file whose content we want to read
    
    Returns:
    a String containing the content of the file
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - getBytes
```
public static byte[] getBytes(Path self)
                       throws IOException
```
    Read the content of the Path and returns it as a byte[].
    
    Parameters:
    self - the file whose content we want to read
    
    Returns:
    a String containing the content of the file
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - setBytes
```
public static void setBytes(Path self,
            byte[] bytes)
                     throws IOException
```
    Write the bytes from the byte array to the Path.
    
    Parameters:
    self - the file to write to
    bytes - the byte[] to write to the file
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - write
```
public static void write(Path self,
         String text)
                  throws IOException
```
    Write the text to the Path.
    
    Parameters:
    self - a Path
    text - the text to write to the Path
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - setText
```
public static void setText(Path self,
           String text)
                    throws IOException
```
    Synonym for write(text) allowing file.text = 'foo'.
    
    Parameters:
    self - a Path
    text - the text to write to the Path
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    write(Path, String)
  - setText
```
public static void setText(Path self,
           String text,
           String charset)
                    throws IOException
```
    Synonym for write(text, charset) allowing:
```
 myFile.setText('some text', charset)
 
```
    or with some help from ExpandoMetaClass, you could do something like:
```
 myFile.metaClass.setText = { String s -> delegate.setText(s, 'UTF-8') }
 myfile.text = 'some text'
 
```
    Parameters:
    self - A Path
    charset - The charset used when writing to the file
    text - The text to write to the Path
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    write(Path, String, String)
  - leftShift
```
public static Path leftShift(Path self,
             Object text)
                      throws IOException
```
    Write the text to the Path.
    
    Parameters:
    self - a Path
    text - the text to write to the Path
    
    Returns:
    the original file
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - leftShift
```
public static Path leftShift(Path self,
             byte[] bytes)
                      throws IOException
```
    Write bytes to a Path.
    
    Parameters:
    self - a Path
    bytes - the byte array to append to the end of the Path
    
    Returns:
    the original file
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - leftShift
```
public static Path leftShift(Path path,
             InputStream data)
                      throws IOException
```
    Append binary data to the file. See append(Path, java.io.InputStream)
    
    Parameters:
    path - a Path
    data - an InputStream of data to write to the file
    
    Returns:
    the file
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - write
```
public static void write(Path self,
         String text,
         String charset)
                  throws IOException
```
    Write the text to the Path, using the specified encoding.
    
    Parameters:
    self - a Path
    text - the text to write to the Path
    charset - the charset used
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - append
```
public static void append(Path self,
          Object text)
                   throws IOException
```
    Append the text at the end of the Path.
    
    Parameters:
    self - a Path
    text - the text to append at the end of the Path
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - append
```
public static void append(Path file,
          Reader reader)
                   throws IOException
```
    Append the text supplied by the Writer at the end of the File.
    
    Parameters:
    file - a Path
    reader - the Reader supplying the text to append at the end of the File
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - append
```
public static void append(Path file,
          Writer writer)
                   throws IOException
```
    Append the text supplied by the Writer at the end of the File.
    
    Parameters:
    file - a File
    writer - the Writer supplying the text to append at the end of the File
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - append
```
public static void append(Path self,
          byte[] bytes)
                   throws IOException
```
    Append bytes to the end of a Path.
    
    Parameters:
    self - a Path
    bytes - the byte array to append to the end of the Path
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - append
```
public static void append(Path self,
          InputStream stream)
                   throws IOException
```
    Append binary data to the file. It will not be interpreted as text.
    
    Parameters:
    self - a Path
    stream - stream to read data from.
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - append
```
public static void append(Path self,
          Object text,
          String charset)
                   throws IOException
```
    Append the text at the end of the Path, using a specified encoding.
    
    Parameters:
    self - a Path
    text - the text to append at the end of the Path
    charset - the charset used
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - append
```
public static void append(Path file,
          Writer writer,
          String charset)
                   throws IOException
```
    Append the text supplied by the Writer at the end of the File, using a specified encoding.
    
    Parameters:
    file - a File
    writer - the Writer supplying the text to append at the end of the File
    charset - the charset used
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - append
```
public static void append(Path file,
          Reader reader,
          String charset)
                   throws IOException
```
    Append the text supplied by the Reader at the end of the File, using a specified encoding.
    
    Parameters:
    file - a File
    reader - the Reader supplying the text to append at the end of the File
    charset - the charset used
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - eachFile
```
public static void eachFile(Path self,
            FileType fileType,
            Closure closure)
                     throws IOException
```
    Invokes the closure for each 'child' file in this 'parent' folder/directory. Both regular files and subfolders/subdirectories can be processed depending on the fileType enum value.
    
    Parameters:
    self - a file object
    fileType - if normal files or directories or both should be processed
    closure - the closure to invoke
    
    Throws:
    
    FileNotFoundException - if the given directory does not exist
    
    IllegalArgumentException - if the provided Path object does not represent a directory
    
    IOException
    Since:
    
    2.3.0
  - eachFile
```
public static void eachFile(Path self,
            Closure closure)
                     throws IOException
```
    Invokes the closure for each 'child' file in this 'parent' folder/directory. Both regular files and subfolders/subdirectories are processed.
    
    Parameters:
    self - a Path (that happens to be a folder/directory)
    closure - a closure (first parameter is the 'child' file)
    
    Throws:
    
    FileNotFoundException - if the given directory does not exist
    
    IllegalArgumentException - if the provided Path object does not represent a directory
    
    IOException
    Since:
    
    2.3.0
    
    See Also:
    eachFile(Path, groovy.io.FileType, groovy.lang.Closure)
  - eachDir
```
public static void eachDir(Path self,
           Closure closure)
                    throws IOException
```
    Invokes the closure for each subdirectory in this directory, ignoring regular files.
    
    Parameters:
    self - a Path (that happens to be a folder/directory)
    closure - a closure (first parameter is the subdirectory file)
    
    Throws:
    
    FileNotFoundException - if the given directory does not exist
    
    IllegalArgumentException - if the provided Path object does not represent a directory
    
    IOException
    Since:
    
    2.3.0
    
    See Also:
    eachFile(Path, groovy.io.FileType, groovy.lang.Closure)
  - eachFileRecurse
```
public static void eachFileRecurse(Path self,
                   FileType fileType,
                   Closure closure)
                            throws IOException
```
    Invokes the closure for each descendant file in this directory. Sub-directories are recursively searched in a depth-first fashion. Both regular files and subdirectories may be passed to the closure depending on the value of fileType.
    
    Parameters:
    self - a file object
    fileType - if normal files or directories or both should be processed
    closure - the closure to invoke on each file
    
    Throws:
    
    FileNotFoundException - if the given directory does not exist
    
    IllegalArgumentException - if the provided Path object does not represent a directory
    
    IOException
    Since:
    
    2.3.0
  - traverse
```
public static void traverse(Path self,
            Map<String,Object> options,
            Closure closure)
                     throws IOException
```
    Invokes closure for each descendant file in this directory tree. Sub-directories are recursively traversed as found. The traversal can be adapted by providing various options in the options Map according to the following keys:
    
    type
    A FileType enum to determine if normal files or directories or both are processed
    
    preDir
    A Closure run before each directory is processed and optionally returning a FileVisitResult value which can be used to control subsequent processing.
    
    preRoot
    A boolean indicating that the 'preDir' closure should be applied at the root level
    
    postDir
    A Closure run after each directory is processed and optionally returning a FileVisitResult value which can be used to control subsequent processing.
    
    postRoot
    A boolean indicating that the 'postDir' closure should be applied at the root level
    
    visitRoot
    A boolean indicating that the given closure should be applied for the root dir (not applicable if the 'type' is set to FileType.FILES)
    
    maxDepth
    The maximum number of directory levels when recursing (default is -1 which means infinite, set to 0 for no recursion)
    
    filter
    A filter to perform on traversed files/directories (using the DefaultGroovyMethods.isCase(Object, Object) method). If set, only files/dirs which match are candidates for visiting.
    
    nameFilter
    A filter to perform on the name of traversed files/directories (using the DefaultGroovyMethods.isCase(Object, Object) method). If set, only files/dirs which match are candidates for visiting. (Must not be set if 'filter' is set)
    
    excludeFilter
    A filter to perform on traversed files/directories (using the DefaultGroovyMethods.isCase(Object, Object) method). If set, any candidates which match won't be visited.
    
    excludeNameFilter
    A filter to perform on the names of traversed files/directories (using the DefaultGroovyMethods.isCase(Object, Object) method). If set, any candidates which match won't be visited. (Must not be set if 'excludeFilter' is set)
    
    sort
    A Closure which if set causes the files and subdirectories for each directory to be processed in sorted order. Note that even when processing only files, the order of visited subdirectories will be affected by this parameter.
    
    This example prints out file counts and size aggregates for groovy source files within a directory tree:
```
 def totalSize = 0
 def count = 0
 def sortByTypeThenName = { a, b ->
     a.isFile() != b.isFile() ? a.isFile() <=> b.isFile() : a.name <=> b.name
 }
 rootDir.traverse(
         type         : FILES,
         nameFilter   : ~/.*\.groovy/,
         preDir       : { if (it.name == '.svn') return SKIP_SUBTREE },
         postDir      : { println "Found $count files in $it.name totalling $totalSize bytes"
                         totalSize = 0; count = 0 },
         postRoot     : true
         sort         : sortByTypeThenName
 ) {it -> totalSize += it.size(); count++ }
 
```
    Parameters:
    self - a Path
    options - a Map of options to alter the traversal behavior
    closure - the Closure to invoke on each file/directory and optionally returning a FileVisitResult value which can be used to control subsequent processing
    
    Throws:
    
    FileNotFoundException - if the given directory does not exist
    
    IllegalArgumentException - if the provided Path object does not represent a directory or illegal filter combinations are supplied
    
    IOException
    Since:
    
    2.3.0
    
    See Also:
    DefaultGroovyMethods.sort(java.util.Collection, groovy.lang.Closure), FileVisitResult, FileType
  - traverse
```
public static void traverse(Path self,
            Closure closure)
                     throws IOException
```
    Invokes the closure for each descendant file in this directory tree. Sub-directories are recursively traversed in a depth-first fashion. Convenience method for traverse(Path, java.util.Map, groovy.lang.Closure) when no options to alter the traversal behavior are required.
    
    Parameters:
    self - a Path
    closure - the Closure to invoke on each file/directory and optionally returning a FileVisitResult value which can be used to control subsequent processing
    
    Throws:
    
    FileNotFoundException - if the given directory does not exist
    
    IllegalArgumentException - if the provided Path object does not represent a directory
    
    IOException
    Since:
    
    2.3.0
    
    See Also:
    traverse(Path, java.util.Map, groovy.lang.Closure)
  - traverse
```
public static void traverse(Path self,
            Map<String,Object> options)
                     throws IOException
```
    Invokes the closure specified with key 'visit' in the options Map for each descendant file in this directory tree. Convenience method for traverse(Path, java.util.Map, groovy.lang.Closure) allowing the 'visit' closure to be included in the options Map rather than as a parameter.
    
    Parameters:
    self - a Path
    options - a Map of options to alter the traversal behavior
    
    Throws:
    
    FileNotFoundException - if the given directory does not exist
    
    IllegalArgumentException - if the provided Path object does not represent a directory or illegal filter combinations are supplied
    
    IOException
    Since:
    
    2.3.0
    
    See Also:
    traverse(Path, java.util.Map, groovy.lang.Closure)
  - eachFileRecurse
```
public static void eachFileRecurse(Path self,
                   Closure closure)
                            throws IOException
```
    Invokes the closure for each descendant file in this directory. Sub-directories are recursively searched in a depth-first fashion. Both regular files and subdirectories are passed to the closure.
    
    Parameters:
    self - a Path
    closure - a closure
    
    Throws:
    
    FileNotFoundException - if the given directory does not exist
    
    IllegalArgumentException - if the provided Path object does not represent a directory
    
    IOException
    Since:
    
    2.3.0
    
    See Also:
    eachFileRecurse(Path, groovy.io.FileType, groovy.lang.Closure)
  - eachDirRecurse
```
public static void eachDirRecurse(Path self,
                  Closure closure)
                           throws IOException
```
    Invokes the closure for each descendant directory of this directory. Sub-directories are recursively searched in a depth-first fashion. Only subdirectories are passed to the closure; regular files are ignored.
    
    Parameters:
    self - a directory
    closure - a closure
    
    Throws:
    
    FileNotFoundException - if the given directory does not exist
    
    IllegalArgumentException - if the provided Path object does not represent a directory
    
    IOException
    Since:
    
    2.3.0
    
    See Also:
    eachFileRecurse(Path, groovy.io.FileType, groovy.lang.Closure)
  - eachFileMatch
```
public static void eachFileMatch(Path self,
                 FileType fileType,
                 Object nameFilter,
                 Closure closure)
                          throws IOException
```
    Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory - calling the DefaultGroovyMethods.isCase(Object, Object) method to determine if a match occurs. This method can be used with different kinds of filters like regular expressions, classes, ranges etc. Both regular files and subdirectories may be candidates for matching depending on the value of fileType.
```
 // collect names of files in baseDir matching supplied regex pattern
 import static groovy.io.FileType.*
 def names = []
 baseDir.eachFileMatch FILES, ~/foo\d\.txt/, { names << it.name }
 assert names == ['foo1.txt', 'foo2.txt']

 // remove all *.bak files in baseDir
 baseDir.eachFileMatch FILES, ~/.*\.bak/, { Path bak -> bak.delete() }

 // print out files > 4K in size from baseDir
 baseDir.eachFileMatch FILES, { new Path(baseDir, it).size() > 4096 }, { println "$it.name ${it.size()}" }
 
```
    Parameters:
    self - a file
    fileType - whether normal files or directories or both should be processed
    nameFilter - the filter to perform on the name of the file/directory (using the DefaultGroovyMethods.isCase(Object, Object) method)
    closure - the closure to invoke
    
    Throws:
    
    FileNotFoundException - if the given directory does not exist
    
    IllegalArgumentException - if the provided Path object does not represent a directory
    
    IOException
    Since:
    
    2.3.0
  - eachFileMatch
```
public static void eachFileMatch(Path self,
                 Object nameFilter,
                 Closure closure)
                          throws IOException
```
    Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory - calling the DefaultGroovyMethods.isCase(Object, Object) method to determine if a match occurs. This method can be used with different kinds of filters like regular expressions, classes, ranges etc. Both regular files and subdirectories are matched.
    
    Parameters:
    self - a file
    nameFilter - the nameFilter to perform on the name of the file (using the DefaultGroovyMethods.isCase(Object, Object) method)
    closure - the closure to invoke
    
    Throws:
    
    FileNotFoundException - if the given directory does not exist
    
    IllegalArgumentException - if the provided Path object does not represent a directory
    
    IOException
    Since:
    
    2.3.0
    
    See Also:
    eachFileMatch(Path, groovy.io.FileType, Object, groovy.lang.Closure)
  - eachDirMatch
```
public static void eachDirMatch(Path self,
                Object nameFilter,
                Closure closure)
                         throws IOException
```
    Invokes the closure for each subdirectory whose name (dir.name) matches the given nameFilter in the given directory - calling the DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object) method to determine if a match occurs. This method can be used with different kinds of filters like regular expressions, classes, ranges etc. Only subdirectories are matched; regular files are ignored.
    
    Parameters:
    self - a file
    nameFilter - the nameFilter to perform on the name of the directory (using the DefaultGroovyMethods.isCase(Object, Object) method)
    closure - the closure to invoke
    
    Throws:
    
    FileNotFoundException - if the given directory does not exist
    
    IllegalArgumentException - if the provided Path object does not represent a directory
    
    IOException
    Since:
    
    2.3.0
    
    See Also:
    eachFileMatch(Path, groovy.io.FileType, Object, groovy.lang.Closure)
  - deleteDir
```
public static boolean deleteDir(Path self)
```
    Deletes a directory with all contained files and subdirectories.
    The method returns
    - true, when deletion was successful
    - true, when it is called for a non existing directory
    - false, when it is called for a file which isn't a directory
    - false, when directory couldn't be deleted
    Parameters:
    self - a Path
    
    Returns:
    true if the file doesn't exist or deletion was successful
    Since:
    
    2.3.0
  - renameTo
```
public static boolean renameTo(Path self,
               String newPathName)
```
    Renames a file.
    
    Parameters:
    self - a Path
    newPathName - The new pathname for the named file
    
    Returns:
    true if and only if the renaming succeeded; false otherwise
    Since:
    
    2.3.0
  - renameTo
```
public static boolean renameTo(Path self,
               URI newPathName)
```
    Renames a file.
    
    Parameters:
    self - a Path
    newPathName - The new target path specified as a URI object
    
    Returns:
    true if and only if the renaming succeeded; false otherwise
    Since:
    
    2.3.0
  - asWritable
```
public static Path asWritable(Path self)
```
    Converts this Path to a Writable.
    
    Parameters:
    self - a Path
    
    Returns:
    a Path which wraps the input file and which implements Writable
    Since:
    
    2.3.0
  - asType
```
public static <T> T asType(Path path,
           Class<T> c)
```
    Converts this Path to a Writable or delegates to default DefaultGroovyMethods.asType(Object, Class).
    
    Parameters:
    path - a Path
    c - the desired class
    
    Returns:
    the converted object
    Since:
    
    2.3.0
  - asWritable
```
public static Path asWritable(Path self,
              String encoding)
```
    Allows a file to return a Writable implementation that can output itself to a Writer stream.
    
    Parameters:
    self - a Path
    encoding - the encoding to be used when reading the file's contents
    
    Returns:
    Path which wraps the input file and which implements Writable
    Since:
    
    2.3.0
  - newReader
```
public static BufferedReader newReader(Path self)
                                throws IOException
```
    Create a buffered reader for this file.
    
    Parameters:
    self - a Path
    
    Returns:
    a BufferedReader
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - newReader
```
public static BufferedReader newReader(Path self,
                       String charset)
                                throws IOException
```
    Create a buffered reader for this file, using the specified charset as the encoding.
    
    Parameters:
    self - a Path
    charset - the charset for this Path
    
    Returns:
    a BufferedReader
    
    Throws:
    
    FileNotFoundException - if the Path was not found
    
    UnsupportedEncodingException - if the encoding specified is not supported
    
    IOException
    Since:
    
    2.3.0
  - withReader
```
public static <T> T withReader(Path self,
               Closure<T> closure)
                    throws IOException
```
    Create a new BufferedReader for this file and then passes it into the closure, ensuring the reader is closed after the closure returns.
    
    Parameters:
    self - a file object
    closure - a closure
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - withReader
```
public static <T> T withReader(Path self,
               String charset,
               Closure<T> closure)
                    throws IOException
```
    Create a new BufferedReader for this file using the specified charset and then passes it into the closure, ensuring the reader is closed after the closure returns.
    
    Parameters:
    self - a file object
    charset - the charset for this input stream
    closure - a closure
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - newOutputStream
```
public static BufferedOutputStream newOutputStream(Path self)
                                            throws IOException
```
    Create a buffered output stream for this file.
    
    Parameters:
    self - a file object
    
    Returns:
    the created OutputStream
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - newDataOutputStream
```
public static DataOutputStream newDataOutputStream(Path self)
                                            throws IOException
```
    Creates a new data output stream for this file.
    
    Parameters:
    self - a file object
    
    Returns:
    the created DataOutputStream
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - withOutputStream
```
public static Object withOutputStream(Path self,
                      Closure closure)
                               throws IOException
```
    Creates a new OutputStream for this file and passes it into the closure. This method ensures the stream is closed after the closure returns.
    
    Parameters:
    self - a Path
    closure - a closure
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.withStream(java.io.OutputStream, groovy.lang.Closure)
  - withInputStream
```
public static Object withInputStream(Path self,
                     Closure closure)
                              throws IOException
```
    Create a new InputStream for this file and passes it into the closure. This method ensures the stream is closed after the closure returns.
    
    Parameters:
    self - a Path
    closure - a closure
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.withStream(java.io.InputStream, groovy.lang.Closure)
  - withDataOutputStream
```
public static <T> T withDataOutputStream(Path self,
                         Closure<T> closure)
                              throws IOException
```
    Create a new DataOutputStream for this file and passes it into the closure. This method ensures the stream is closed after the closure returns.
    
    Parameters:
    self - a Path
    closure - a closure
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.withStream(java.io.OutputStream, groovy.lang.Closure)
  - withDataInputStream
```
public static <T> T withDataInputStream(Path self,
                        Closure<T> closure)
                             throws IOException
```
    Create a new DataInputStream for this file and passes it into the closure. This method ensures the stream is closed after the closure returns.
    
    Parameters:
    self - a Path
    closure - a closure
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.withStream(java.io.InputStream, groovy.lang.Closure)
  - newWriter
```
public static BufferedWriter newWriter(Path self)
                                throws IOException
```
    Create a buffered writer for this file.
    
    Parameters:
    self - a Path
    
    Returns:
    a BufferedWriter
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - newWriter
```
public static BufferedWriter newWriter(Path self,
                       boolean append)
                                throws IOException
```
    Creates a buffered writer for this file, optionally appending to the existing file content.
    
    Parameters:
    self - a Path
    append - true if data should be appended to the file
    
    Returns:
    a BufferedWriter
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - newWriter
```
public static BufferedWriter newWriter(Path self,
                       String charset,
                       boolean append)
                                throws IOException
```
    Helper method to create a buffered writer for a file. If the given charset is "UTF-16BE" or "UTF-16LE", the requisite byte order mark is written to the stream before the writer is returned.
    
    Parameters:
    self - a Path
    charset - the name of the encoding used to write in this file
    append - true if in append mode
    
    Returns:
    a BufferedWriter
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - newWriter
```
public static BufferedWriter newWriter(Path self,
                       String charset)
                                throws IOException
```
    Creates a buffered writer for this file, writing data using the given encoding.
    
    Parameters:
    self - a Path
    charset - the name of the encoding used to write in this file
    
    Returns:
    a BufferedWriter
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - withWriter
```
public static <T> T withWriter(Path self,
               Closure<T> closure)
                    throws IOException
```
    Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns.
    
    Parameters:
    self - a Path
    closure - a closure
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - withWriter
```
public static <T> T withWriter(Path self,
               String charset,
               Closure<T> closure)
                    throws IOException
```
    Creates a new BufferedWriter for this file, passes it to the closure, and ensures the stream is flushed and closed after the closure returns. The writer will use the given charset encoding.
    
    Parameters:
    self - a Path
    charset - the charset used
    closure - a closure
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - withWriterAppend
```
public static <T> T withWriterAppend(Path self,
                     String charset,
                     Closure<T> closure)
                          throws IOException
```
    Create a new BufferedWriter which will append to this file. The writer is passed to the closure and will be closed before this method returns.
    
    Parameters:
    self - a Path
    charset - the charset used
    closure - a closure
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - withWriterAppend
```
public static <T> T withWriterAppend(Path self,
                     Closure<T> closure)
                          throws IOException
```
    Create a new BufferedWriter for this file in append mode. The writer is passed to the closure and is closed after the closure returns.
    
    Parameters:
    self - a Path
    closure - a closure
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - newPrintWriter
```
public static PrintWriter newPrintWriter(Path self)
                                  throws IOException
```
    Create a new PrintWriter for this file.
    
    Parameters:
    self - a Path
    
    Returns:
    the created PrintWriter
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - newPrintWriter
```
public static PrintWriter newPrintWriter(Path self,
                         String charset)
                                  throws IOException
```
    Create a new PrintWriter for this file, using specified charset.
    
    Parameters:
    self - a Path
    charset - the charset
    
    Returns:
    a PrintWriter
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - withPrintWriter
```
public static <T> T withPrintWriter(Path self,
                    Closure<T> closure)
                         throws IOException
```
    Create a new PrintWriter for this file which is then passed it into the given closure. This method ensures its the writer is closed after the closure returns.
    
    Parameters:
    self - a Path
    closure - the closure to invoke with the PrintWriter
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - withPrintWriter
```
public static <T> T withPrintWriter(Path self,
                    String charset,
                    Closure<T> closure)
                         throws IOException
```
    Create a new PrintWriter with a specified charset for this file. The writer is passed to the closure, and will be closed before this method returns.
    
    Parameters:
    self - a Path
    charset - the charset
    closure - the closure to invoke with the PrintWriter
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - newInputStream
```
public static BufferedInputStream newInputStream(Path self)
                                          throws IOException
```
    Creates a buffered input stream for this file.
    
    Parameters:
    self - a Path
    
    Returns:
    a BufferedInputStream of the file
    
    Throws:
    
    FileNotFoundException - if the file is not found.
    
    IOException
    Since:
    
    2.3.0
  - newDataInputStream
```
public static DataInputStream newDataInputStream(Path self)
                                          throws IOException
```
    Create a data input stream for this file
    
    Parameters:
    self - a Path
    
    Returns:
    a DataInputStream of the file
    
    Throws:
    
    FileNotFoundException - if the file is not found.
    
    IOException
    Since:
    
    2.3.0
  - eachByte
```
public static void eachByte(Path self,
            Closure closure)
                     throws IOException
```
    Traverse through each byte of this Path
    
    Parameters:
    self - a Path
    closure - a closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.eachByte(java.io.InputStream, groovy.lang.Closure)
  - eachByte
```
public static void eachByte(Path self,
            int bufferLen,
            Closure closure)
                     throws IOException
```
    Traverse through the bytes of this Path, bufferLen bytes at a time.
    
    Parameters:
    self - a Path
    bufferLen - the length of the buffer to use.
    closure - a 2 parameter closure which is passed the byte[] and a number of bytes successfully read.
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.eachByte(java.io.InputStream, int, groovy.lang.Closure)
  - filterLine
```
public static Writable filterLine(Path self,
                  Closure closure)
                           throws IOException
```
    Filters the lines of a Path and creates a Writable in return to stream the filtered lines.
    
    Parameters:
    self - a Path
    closure - a closure which returns a boolean indicating to filter the line or not
    
    Returns:
    a Writable closure
    
    Throws:
    
    IOException - if self is not readable
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.filterLine(java.io.Reader, groovy.lang.Closure)
  - filterLine
```
public static Writable filterLine(Path self,
                  String charset,
                  Closure closure)
                           throws IOException
```
    Filters the lines of a Path and creates a Writable in return to stream the filtered lines.
    
    Parameters:
    self - a Path
    charset - opens the file with a specified charset
    closure - a closure which returns a boolean indicating to filter the line or not
    
    Returns:
    a Writable closure
    
    Throws:
    
    IOException - if an IOException occurs
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.filterLine(java.io.Reader, groovy.lang.Closure)
  - filterLine
```
public static void filterLine(Path self,
              Writer writer,
              Closure closure)
                       throws IOException
```
    Filter the lines from this Path, and write them to the given writer based on the given closure predicate.
    
    Parameters:
    self - a Path
    writer - a writer destination to write filtered lines to
    closure - a closure which takes each line as a parameter and returns true if the line should be written to this writer.
    
    Throws:
    
    IOException - if self is not readable
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.filterLine(java.io.Reader, java.io.Writer, groovy.lang.Closure)
  - filterLine
```
public static void filterLine(Path self,
              Writer writer,
              String charset,
              Closure closure)
                       throws IOException
```
    Filter the lines from this Path, and write them to the given writer based on the given closure predicate.
    
    Parameters:
    self - a Path
    writer - a writer destination to write filtered lines to
    charset - opens the file with a specified charset
    closure - a closure which takes each line as a parameter and returns true if the line should be written to this writer.
    
    Throws:
    
    IOException - if an IO error occurs
    Since:
    
    2.3.0
    
    See Also:
    IOGroovyMethods.filterLine(java.io.Reader, java.io.Writer, groovy.lang.Closure)
  - readBytes
```
public static byte[] readBytes(Path self)
                        throws IOException
```
    Reads the content of the file into a byte array.
    
    Parameters:
    self - a Path
    
    Returns:
    a byte array with the contents of the file.
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0
  - withCloseable
```
public static <T> T withCloseable(Closeable self,
                  Closure<T> action)
                       throws IOException
```
    Allows this closeable to be used within the closure, ensuring that it is closed once the closure has been executed and before this method returns.
    
    Parameters:
    self - the Closeable
    action - the closure taking the Closeable as parameter
    
    Returns:
    the value returned by the closure
    
    Throws:
    
    IOException - if an IOException occurs.
    Since:
    
    2.3.0

Class NioGroovyMethods

Constructor Summary

Method Summary

Methods inherited from class org.codehaus.groovy.runtime.DefaultGroovyMethodsSupport

Methods inherited from class java.lang.Object

Constructor Detail

NioGroovyMethods

Method Detail

size

newObjectOutputStream

withObjectOutputStream

newObjectInputStream

newObjectInputStream

eachObject

withObjectInputStream

withObjectInputStream

eachLine

eachLine

eachLine

eachLine

splitEachLine

splitEachLine

splitEachLine

splitEachLine

readLines

readLines

getText

getText

getBytes

setBytes

write

setText

setText

leftShift

leftShift

leftShift

write

append

append

append

append

append

append

append

append

eachFile

eachFile

eachDir

eachFileRecurse

traverse

traverse

traverse

eachFileRecurse

eachDirRecurse

eachFileMatch

eachFileMatch

eachDirMatch

deleteDir

renameTo

renameTo

asWritable

asType

asWritable

newReader

newReader

withReader

withReader

newOutputStream

newDataOutputStream

withOutputStream

withInputStream

withDataOutputStream

withDataInputStream

newWriter

newWriter

newWriter

newWriter

withWriter

withWriter

withWriterAppend