Java - File toString() method



Description

The Java File toString() method returns the pathname string returned by the getPath() method of this abstract pathname. toString() method returns the pathname string that was used to create the File object. It does not return the absolute path but rather the exact string that was passed to the File constructor.

Declaration

Following is the declaration for java.io.File.toString() method −

public String toString()

Parameters

NA

Return Value

The method returns string form of this abstract pathname.

Exception

NA

Example - Usage of File toString() method

The following example shows the usage of Java File toString() method. We've created two File references. Then we're creating a File Object using test.txt which is not present in the current directory. Then we've created the file using createNewFile() method. Now using getAbsoluteFile() method, we're getting the file and getting the string representation of file as its path using toString() method and then we're checking if file exists using exists() method.

FileDemo.java

package com.tutorialspoint;

import java.io.File;

public class FileDemo {
   public static void main(String[] args) {      
      File f = null;
      File f1 = null;
      String path = "";
      boolean bool = false;
      
      try {
         // create new files
         f = new File("test.txt");
         
         // create new file in the system
         f.createNewFile();
         
         // create new file object from the absolute path
         f1 = f.getAbsoluteFile();
         
         // returns true if the file exists
         bool = f1.exists();
         
         // returns string representation of the file
         path = f1.toString();
         
         // if file exists
         if(bool) {
         
            // prints the file
            System.out.print(path+" Exists? "+ bool);
         }
         
      } catch(Exception e) {
         // if any error occurs
         e.printStackTrace();
      }
   }
}

Output

Let us compile and run the above program, this will produce the following result−

F:\Workspace\Tester\test.txt Exists? true

Example - Usage of File toString() method

The following example shows the usage of Java File toString() method. We've created a File reference. Then we're creating a File Object using F:/test.txt which is present in the provided directory. Now using getAbsoluteFile() method, we're getting the file and printing its string representation as path using toString() method.

FileDemo.java

package com.tutorialspoint;

import java.io.File;

public class FileDemo {
   public static void main(String[] args) {      
      File f = null;
      
      try {
         // create new files
         f = new File("F:/Test2/test.txt");         
    
         // get the file
         File f1 = f.getAbsoluteFile();
         
         // prints string representation of the file
         System.out.println("File: "+f1.toString());
         
      } catch(Exception e) {
         // if any error occurs
         e.printStackTrace();
      }
   }
}

Output

Let us compile and run the above program, this will produce the following result−

File: F:\Test2\test.txt

Example - Usage of File toString() method

The following example shows the usage of Java File toString() method. We've created a File reference. Then we're creating a File Object using F:/test directory which is present in the provided location. Now using getAbsoluteFile() method, we're getting the directory and its string representation as path using toString() method.

FileDemo.java

package com.tutorialspoint;

import java.io.File;

public class FileDemo {
   public static void main(String[] args) {      
      File f = null;
      
      try {
         // create new files
         f = new File("F:/test2");         
    
         // get the file
         File f1 = f.getAbsoluteFile();
         
         // prints the string representation of the file
         System.out.println("Directory: "+f1.toString());
         
      } catch(Exception e) {
         // if any error occurs
         e.printStackTrace();
      }
   }
}

Output

Let us compile and run the above program, this will produce the following result−

Directory: F:\test2

Example - Using toString() Method

The following example shows the usage of Java File toString() method. We've created a File reference. Then we're creating a File Object using F:/test directory which is present in the provided location. Now using getAbsoluteFile() method, we're getting the directory and its string representation as path using toString() method.

FileDemo.java

package com.tutorialspoint;

import java.io.File;

public class FileDemo {
   public static void main(String[] args) {      
      // Create a File object with a relative path
      File file1 = new File("example.txt");
      // Create a File object with an absolute path
      File file2 = new File("C:\\Users\\testfile.txt");
      // Print the pathname string using toString()
      System.out.println("File 1 toString(): " + file1.toString());
      System.out.println("File 2 toString(): " + file2.toString());
   }
}

Output

Let us compile and run the above program, this will produce the following result−

File 1 toString(): example.txt
File 2 toString(): C:\Users\testfile.txt

Explanation

  • A File object (file1) is created using a relative path ("example.txt").

  • Another File object (file2) is created using an absolute path ("C:\\Users\\testfile.txt").

  • The toString() method is called on both objects, returning the same string that was passed to the constructor.

Key Points About toString() Method

  • Returns the exact pathname string used when creating the File object.

  • If the File object was created using a relative path, toString() returns the same relative path.

  • If the File object was created using an absolute path, toString() returns the absolute path.

java_io_file_methods.htm
Advertisements