Package org.codehaus.groovy.runtime

Class NioGroovyMethods

  • @Deprecated
public class NioGroovyMethods
extends DefaultGroovyMethodsSupport
    Deprecated.
    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.

    • Constructor Detail

      • NioGroovyMethods

        public NioGroovyMethods()
        Deprecated.

    • Method Detail

      • size

        @Deprecated
public static long size​(Path self)
                 throws IOException
        Deprecated.
        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

        @Deprecated
public static ObjectOutputStream newObjectOutputStream​(Path self)
                                                throws IOException
        Deprecated.
        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

      • newObjectInputStream

        @Deprecated
public static ObjectInputStream newObjectInputStream​(Path self)
                                              throws IOException
        Deprecated.
        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

        @Deprecated
public static ObjectInputStream newObjectInputStream​(Path self,
                                                     ClassLoader classLoader)
                                              throws IOException
        Deprecated.
        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

      • withObjectInputStream

        @Deprecated
public static <T> T withObjectInputStream​(Path self,
                                          ClassLoader classLoader,
                                          Closure<T> closure)
                                   throws IOException
        Deprecated.
        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

        @Deprecated
public static <T> T eachLine​(Path self,
                             Closure<T> closure)
                      throws IOException
        Deprecated.
        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

        @Deprecated
public static <T> T eachLine​(Path self,
                             String charset,
                             Closure<T> closure)
                      throws IOException
        Deprecated.
        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

        @Deprecated
public static <T> T eachLine​(Path self,
                             int firstLine,
                             Closure<T> closure)
                      throws IOException
        Deprecated.
        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

        @Deprecated
public static <T> T eachLine​(Path self,
                             String charset,
                             int firstLine,
                             Closure<T> closure)
                      throws IOException
        Deprecated.
        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

        @Deprecated
public static <T> T splitEachLine​(Path self,
                                  String regex,
                                  Closure<T> closure)
                           throws IOException
        Deprecated.
        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

        @Deprecated
public static <T> T splitEachLine​(Path self,
                                  Pattern pattern,
                                  Closure<T> closure)
                           throws IOException
        Deprecated.
        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

        @Deprecated
public static <T> T splitEachLine​(Path self,
                                  String regex,
                                  String charset,
                                  Closure<T> closure)
                           throws IOException
        Deprecated.
        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

        @Deprecated
public static <T> T splitEachLine​(Path self,
                                  Pattern pattern,
                                  String charset,
                                  Closure<T> closure)
                           throws IOException
        Deprecated.
        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)

      • getText

        @Deprecated
public static String getText​(Path self,
                             String charset)
                      throws IOException
        Deprecated.
        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

        @Deprecated
public static String getText​(Path self)
                      throws IOException
        Deprecated.
        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

        @Deprecated
public static byte[] getBytes​(Path self)
                       throws IOException
        Deprecated.
        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

        @Deprecated
public static void setBytes​(Path self,
                            byte[] bytes)
                     throws IOException
        Deprecated.
        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

        @Deprecated
public static void write​(Path self,
                         String text)
                  throws IOException
        Deprecated.
        Write the text to the Path without writing a BOM .
        Parameters:
        self - a Path
        text - the text to write to the Path
        Throws:
        IOException - if an IOException occurs.
        Since:
        2.3.0

      • write

        @Deprecated
public static void write​(Path self,
                         String text,
                         boolean writeBom)
                  throws IOException
        Deprecated.
        Write the text to the Path. If the default charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias) and writeBom is true, the requisite byte order mark is written to the file before the text.
        Parameters:
        self - a Path
        text - the text to write to the Path
        writeBom - whether to write the BOM
        Throws:
        IOException - if an IOException occurs.
        Since:
        2.5.0

      • setText

        @Deprecated
public static void setText​(Path self,
                           String text)
                    throws IOException
        Deprecated.
        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

        @Deprecated
public static void setText​(Path self,
                           String text,
                           String charset)
                    throws IOException
        Deprecated.
        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

        @Deprecated
public static Path leftShift​(Path self,
                             Object text)
                      throws IOException
        Deprecated.
        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

        @Deprecated
public static Path leftShift​(Path self,
                             byte[] bytes)
                      throws IOException
        Deprecated.
        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

      • write

        @Deprecated
public static void write​(Path self,
                         String text,
                         String charset)
                  throws IOException
        Deprecated.
        Write the text to the Path without writing a BOM, 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

      • write

        @Deprecated
public static void write​(Path self,
                         String text,
                         String charset,
                         boolean writeBom)
                  throws IOException
        Deprecated.
        Write the text to the Path, using the specified encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias) and writeBom is true, the requisite byte order mark is written to the file before the text.
        Parameters:
        self - a Path
        text - the text to write to the Path
        charset - the charset used
        writeBom - whether to write a BOM
        Throws:
        IOException - if an IOException occurs.
        Since:
        2.5.0

      • append

        @Deprecated
public static void append​(Path self,
                          Object text)
                   throws IOException
        Deprecated.
        Append the text at the end of the Path without writing a BOM.
        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

        @Deprecated
public static void append​(Path file,
                          Reader reader)
                   throws IOException
        Deprecated.
        Append the text supplied by the Writer at the end of the File without writing a BOM.
        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

        @Deprecated
public static void append​(Path file,
                          Writer writer)
                   throws IOException
        Deprecated.
        Append the text supplied by the Writer at the end of the File without writing a BOM.
        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

        @Deprecated
public static void append​(Path self,
                          byte[] bytes)
                   throws IOException
        Deprecated.
        Append bytes to the end of a Path. It will not be interpreted as text.
        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

        @Deprecated
public static void append​(Path self,
                          InputStream stream)
                   throws IOException
        Deprecated.
        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

        @Deprecated
public static void append​(Path self,
                          Object text,
                          boolean writeBom)
                   throws IOException
        Deprecated.
        Append the text at the end of the Path. If the default charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias) and writeBom is true, the requisite byte order mark is written to the file before the text.
        Parameters:
        self - a Path
        text - the text to append at the end of the Path
        writeBom - whether to write the BOM
        Throws:
        IOException - if an IOException occurs.
        Since:
        2.5.0

      • append

        @Deprecated
public static void append​(Path self,
                          Object text,
                          String charset)
                   throws IOException
        Deprecated.
        Append the text at the end of the Path without writing a BOM, 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

        @Deprecated
public static void append​(Path self,
                          Object text,
                          String charset,
                          boolean writeBom)
                   throws IOException
        Deprecated.
        Append the text at the end of the Path, using a specified encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), writeBom is true, and the file doesn't already exist, the requisite byte order mark is written to the file before the text is appended.
        Parameters:
        self - a Path
        text - the text to append at the end of the Path
        charset - the charset used
        writeBom - whether to write the BOM
        Throws:
        IOException - if an IOException occurs.
        Since:
        2.5.0

      • append

        @Deprecated
public static void append​(Path file,
                          Writer writer,
                          boolean writeBom)
                   throws IOException
        Deprecated.
        Append the text supplied by the Writer at the end of the File, using a specified encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), writeBom is true, and the file doesn't already exist, the requisite byte order mark is written to the file before the text is appended.
        Parameters:
        file - a File
        writer - the Writer supplying the text to append at the end of the File
        writeBom - whether to write the BOM
        Throws:
        IOException - if an IOException occurs.
        Since:
        2.5.0

      • append

        @Deprecated
public static void append​(Path file,
                          Writer writer,
                          String charset)
                   throws IOException
        Deprecated.
        Append the text supplied by the Writer at the end of the File without writing a BOM, 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

        @Deprecated
public static void append​(Path file,
                          Writer writer,
                          String charset,
                          boolean writeBom)
                   throws IOException
        Deprecated.
        Append the text supplied by the Writer at the end of the File, using a specified encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), writeBom is true, and the file doesn't already exist, the requisite byte order mark is written to the file before the text is appended.
        Parameters:
        file - a File
        writer - the Writer supplying the text to append at the end of the File
        charset - the charset used
        writeBom - whether to write the BOM
        Throws:
        IOException - if an IOException occurs.
        Since:
        2.5.0

      • append

        @Deprecated
public static void append​(Path file,
                          Reader reader,
                          boolean writeBom)
                   throws IOException
        Deprecated.
        Append the text supplied by the Reader at the end of the File, using a specified encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), writeBom is true, and the file doesn't already exist, the requisite byte order mark is written to the file before the text is appended.
        Parameters:
        file - a File
        reader - the Reader supplying the text to append at the end of the File
        writeBom - whether to write the BOM
        Throws:
        IOException - if an IOException occurs.
        Since:
        2.5.0

      • append

        @Deprecated
public static void append​(Path file,
                          Reader reader,
                          String charset)
                   throws IOException
        Deprecated.
        Append the text supplied by the Reader at the end of the File without writing a BOM, 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

      • append

        @Deprecated
public static void append​(Path file,
                          Reader reader,
                          String charset,
                          boolean writeBom)
                   throws IOException
        Deprecated.
        Append the text supplied by the Reader at the end of the File, using a specified encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), writeBom is true, and the file doesn't already exist, the requisite byte order mark is written to the file before the text is appended.
        Parameters:
        file - a File
        reader - the Reader supplying the text to append at the end of the File
        charset - the charset used
        writeBom - whether to write the BOM
        Throws:
        IOException - if an IOException occurs.
        Since:
        2.5.0

      • eachFile

        @Deprecated
public static void eachFile​(Path self,
                            FileType fileType,
                            Closure closure)
                     throws IOException
        Deprecated.
        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 Path (that happens to be a folder/directory)
        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

      • eachFileRecurse

        @Deprecated
public static void eachFileRecurse​(Path self,
                                   FileType fileType,
                                   Closure closure)
                            throws IOException
        Deprecated.
        Processes each descendant file in this directory and any sub-directories. Processing consists of potentially calling closure passing it the current file (which may be a normal file or subdirectory) and then if a subdirectory was encountered, recursively processing the subdirectory. Whether the closure is called is determined by whether the file was a normal file or subdirectory and the value of fileType.
        Parameters:
        self - a Path (that happens to be a folder/directory)
        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

        @Deprecated
public static void traverse​(Path self,
                            Map<String,​Object> options,
                            Closure closure)
                     throws IOException
        Deprecated.
        Processes each descendant file in this directory and any sub-directories. Processing consists of potentially calling closure passing it the current file (which may be a normal file or subdirectory) and then if a subdirectory was encountered, recursively processing the subdirectory.

        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 (that happens to be a folder/directory)
        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

      • eachFileMatch

        @Deprecated
public static void eachFileMatch​(Path self,
                                 FileType fileType,
                                 Object nameFilter,
                                 Closure closure)
                          throws IOException
        Deprecated.
        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 Path (that happens to be a folder/directory)
        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

      • deleteDir

        @Deprecated
public static boolean deleteDir​(Path self)
        Deprecated.
        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

        @Deprecated
public static boolean renameTo​(Path self,
                               String newPathName)
        Deprecated.
        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

        @Deprecated
public static boolean renameTo​(Path self,
                               URI newPathName)
        Deprecated.
        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

        @Deprecated
public static Path asWritable​(Path self)
        Deprecated.
        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

      • asWritable

        @Deprecated
public static Path asWritable​(Path self,
                              String encoding)
        Deprecated.
        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

        @Deprecated
public static BufferedReader newReader​(Path self)
                                throws IOException
        Deprecated.
        Create a buffered reader for this file.
        Parameters:
        self - a Path
        Returns:
        a BufferedReader
        Throws:
        IOException - if an IOException occurs.
        Since:
        2.3.0

      • withReader

        @Deprecated
public static <T> T withReader​(Path self,
                               Closure<T> closure)
                        throws IOException
        Deprecated.
        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

        @Deprecated
public static <T> T withReader​(Path self,
                               String charset,
                               Closure<T> closure)
                        throws IOException
        Deprecated.
        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. The writer will use the given charset encoding, but will not write a BOM.
        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

        @Deprecated
public static BufferedOutputStream newOutputStream​(Path self)
                                            throws IOException
        Deprecated.
        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

        @Deprecated
public static DataOutputStream newDataOutputStream​(Path self)
                                            throws IOException
        Deprecated.
        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

      • newWriter

        @Deprecated
public static BufferedWriter newWriter​(Path self)
                                throws IOException
        Deprecated.
        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

        @Deprecated
public static BufferedWriter newWriter​(Path self,
                                       boolean append)
                                throws IOException
        Deprecated.
        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

        @Deprecated
public static BufferedWriter newWriter​(Path self,
                                       String charset,
                                       boolean append)
                                throws IOException
        Deprecated.
        Helper method to create a buffered writer for a file without writing a BOM.
        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

        @Deprecated
public static BufferedWriter newWriter​(Path self,
                                       String charset,
                                       boolean append,
                                       boolean writeBom)
                                throws IOException
        Deprecated.
        Helper method to create a buffered writer for a file. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), 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
        writeBom - whether to write a BOM
        Returns:
        a BufferedWriter
        Throws:
        IOException - if an IOException occurs.
        Since:
        2.5.0

      • newWriter

        @Deprecated
public static BufferedWriter newWriter​(Path self,
                                       String charset)
                                throws IOException
        Deprecated.
        Creates a buffered writer for this file without writing a BOM, 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

        @Deprecated
public static <T> T withWriter​(Path self,
                               Closure<T> closure)
                        throws IOException
        Deprecated.
        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 not write a BOM.
        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

        @Deprecated
public static <T> T withWriter​(Path self,
                               String charset,
                               Closure<T> closure)
                        throws IOException
        Deprecated.
        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, but will not write a BOM.
        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

      • withWriter

        @Deprecated
public static <T> T withWriter​(Path self,
                               String charset,
                               boolean writeBom,
                               Closure<T> closure)
                        throws IOException
        Deprecated.
        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. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), writeBom is true, and the file doesn't already exist, the requisite byte order mark is written to the stream when the writer is created.
        Parameters:
        self - a Path
        charset - the charset used
        writeBom - whether to write the BOM
        closure - a closure
        Returns:
        the value returned by the closure
        Throws:
        IOException - if an IOException occurs.
        Since:
        2.5.0

      • withWriterAppend

        @Deprecated
public static <T> T withWriterAppend​(Path self,
                                     String charset,
                                     Closure<T> closure)
                              throws IOException
        Deprecated.
        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. The writer will use the given charset encoding, but will not write a BOM.
        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

        @Deprecated
public static <T> T withWriterAppend​(Path self,
                                     String charset,
                                     boolean writeBom,
                                     Closure<T> closure)
                              throws IOException
        Deprecated.
        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. The writer will use the given charset encoding. If the given charset is "UTF-16BE" or "UTF-16LE" (or an equivalent alias), writeBom is true, and the file doesn't already exist, the requisite byte order mark is written to the stream when the writer is created.
        Parameters:
        self - a Path
        charset - the charset used
        writeBom - whether to write the BOM
        closure - a closure
        Returns:
        the value returned by the closure
        Throws:
        IOException - if an IOException occurs.
        Since:
        2.5.0

      • withWriterAppend

        @Deprecated
public static <T> T withWriterAppend​(Path self,
                                     Closure<T> closure)
                              throws IOException
        Deprecated.
        Create a new BufferedWriter for this file in append mode. The writer is passed to the closure and is closed after the closure returns. The writer will not write a BOM.
        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

        @Deprecated
public static PrintWriter newPrintWriter​(Path self)
                                  throws IOException
        Deprecated.
        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

        @Deprecated
public static PrintWriter newPrintWriter​(Path self,
                                         String charset)
                                  throws IOException
        Deprecated.
        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

        @Deprecated
public static <T> T withPrintWriter​(Path self,
                                    Closure<T> closure)
                             throws IOException
        Deprecated.
        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

        @Deprecated
public static <T> T withPrintWriter​(Path self,
                                    String charset,
                                    Closure<T> closure)
                             throws IOException
        Deprecated.
        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

      • readBytes

        @Deprecated
public static byte[] readBytes​(Path self)
                        throws IOException
        Deprecated.
        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