Groovy - File I/O

---

---

Groovy provides a number of helper methods when working with I/O. Groovy provides easier classes to provide the following functionalities for files.

• Reading files
• Writing to files
• Traversing file trees
• Reading and writing data objects to files

In addition to this, you can always use the normal Java classes listed below for File I/O operations.

• java.io.File
• java.io.InputStream
• java.io.OutputStream
• java.io.Reader
• java.io.Writer

Example - Reading files

The following example will output all the lines of a text file in Groovy. The method eachLine is in-built in the File class in Groovy for the purpose of ensuring that each line of the text file is read.

Example.groovy

import java.io.File 
class Example { 
   static void main(String[] args) { 
      new File("E:/Example.txt").eachLine {  
         line -> println "line : $line"; 
      } 
   } 
}

Output

The File class is used to instantiate a new object which takes the file name as the parameter. It then takes the function of eachLine, puts it to a variable called line and prints it accordingly.

If the file contains the following lines, they will be printed.

line : Example1
line : Example2

Example - Reading the Contents of a File as an Entire String

If you want to get the entire contents of the file as a string, you can use the text property of the file class. The following example shows how this can be done.

Example.groovy

class Example { 
   static void main(String[] args) { 
      File file = new File("E:/Example.txt") 
      println file.text 
   } 
}

Output

If the file contains the following lines, they will be printed.

line : Example1 
line : Example2

Example - Writing to Files

If you want to write to files, you need to use the writer class to output text to a file. The following example shows how this can be done.

Example.groovy

import java.io.File 
class Example { 
   static void main(String[] args) { 
      new File('E:/','Example.txt').withWriter('utf-8') { 
         writer -> writer.writeLine 'Hello World' 
      }  
   } 
}

Output

If you open the file Example.txt, you will see the words Hello World printed to the file.

Hello World

Example - Getting the Size of a File

If you want to get the size of the file one can use the length property of the file class to get the size of the file. The following example shows how this can be done.

Example.groovy

class Example {
   static void main(String[] args) {
      File file = new File("E:/Example.txt")
      println "The file ${file.absolutePath} has ${file.length()} bytes"
   } 
}

Output

The above code would show the size of the file in bytes.

45

Example - Testing if a File is a Directory

If you want to see if a path is a file or a directory, one can use the isFile and isDirectory option of the File class. The following example shows how this can be done.

Example.groovy

class Example { 
   static void main(String[] args) { 
      def file = new File('E:/') 
      println "File? ${file.isFile()}" 
      println "Directory? ${file.isDirectory()}" 
   } 
}

Output

The above code would show the following output −

File? false 
Directory? True

Example - Creating a Directory

If you want to create a new directory you can use the mkdir function of the File class. The following example shows how this can be done.

Example.groovy

class Example {
   static void main(String[] args) {
      def file = new File('E:/Directory')
      file.mkdir()
   } 
}

Output

The directory E:\Directory will be created if it does not exist.

Example - Deleting a File

If you want to delete a file you can use the delete function of the File class. The following example shows how this can be done.

Example.groovy

class Example {
   static void main(String[] args) {
      def file = new File('E:/Example.txt')
      file.delete()
   } 
}

Output

The file will be deleted if it exists.

Example - Copying files

Groovy also provides the functionality to copy the contents from one file to another. The following example shows how this can be done.

Example.groovy

class Example {
   static void main(String[] args) {
      def src = new File("E:/Example.txt")
      def dst = new File("E:/Example1.txt")
      dst << src.text
   } 
}

Output

The file Example1.txt will be created and all of the contents of the file Example.txt will be copied to this file.

Example - Getting Directory Contents

Groovy also provides the functionality to list the drives and files in a drive.

The following example shows how the drives on a machine can be displayed by using the listRoots function of the File class.

Example.groovy

class Example { 
   static void main(String[] args) { 
      def rootFiles = new File("test").listRoots() 
      rootFiles.each { 
         file -> println file.absolutePath 
      }
   }
}

Output

Depending on the drives available on your machine, the output could vary. On a standard machine the output would be similar to the following one −

C:\ 
D:\

Example - Listing files of a directory

The following example shows how to list the files in a particular directory by using the eachFile function of the File class.

Example.groovy

class Example {
   static void main(String[] args) {
      new File("E:/Temp").eachFile() {  
         file->println file.getAbsolutePath()
      }
   } 
}

Output

The output would display all of the files in the directory E:\Temp

Example - Recursively Listing files of a directory

If you want to recursively display all of files in a directory and its subdirectories, then you would use the eachFileRecurse function of the File class. The following example shows how this can be done.

Example.groovy

class Example { 
   static void main(String[] args) {
      new File("E:/temp").eachFileRecurse() {
         file -> println file.getAbsolutePath()
      }
   }
} 

Output

The output would display all of the files in the directory E:\Temp and in its subdirectories if they exist.