Java - File getTotalSpace() method

---

---

Description

The Java File getTotalSpace() method returns the size of the partition named by this abstract pathname.

Declaration

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

public long getTotalSpace()

Parameters

NA

Return Value

The method returns the size, in bytes, of the partition.

Exception

• SecurityException − If a security manager exists and it denies RuntimePermission("getFileSystemAttributes") or its SecurityManager. checkRead(String) denies read access to the file name by this abstract pathname.

Example - Usage of File getTotalSpace() method

The following example shows the usage of Java File getTotalSpace() method. We've created a File reference. Then we're creating a File Object using F:/test.txt which is present in the provided location. Now using getTotalSpace() method, we're getting the total space in the partition.

FileDemo.java

package com.tutorialspoint;

import java.io.File;

public class FileDemo {
   public static void main(String[] args) {      
      File f = null;
      long v;
      boolean bool = false;      
      try {
         // create new file
         f = new File("F:\\test.txt");
         
         // get number of allocated bytes
         v = f.getTotalSpace();
         
         // true if the file path exists
         bool = f.exists();
         
         // if file exists
         if(bool) {
         
            // prints
            System.out.print("number of allocated bytes: "+v);
         }
         
      } catch(Exception e) {
         // if any error occurs
         e.printStackTrace();
      }
   }
}

Output

Let us compile and run the above program, this will produce the following result(depends on system's free space)−

number of allocated bytes: 177142231040

Example - Usage of File getTotalSpace() method

The following example shows the usage of Java File getTotalSpace() method. We've created a File reference. Then we're creating a File Object using C:/test.txt which is present in the provided location. Now using getTotalSpace() method, we're getting the allocated bytes in the partition.

FileDemo.java

package com.tutorialspoint;

import java.io.File;

public class FileDemo {
   public static void main(String[] args) {      
      File f = null;
      long v;
      boolean bool = false;      
      try {
         
         // create new file
         f = new File("C:\\test");
         
         // get number of allocated bytes
         v = f.getTotalSpace();
         
         // true if the file path exists
         bool = f.exists();
         
         // if file exists
         if(bool) {
         
            // prints
            System.out.print("number of allocated bytes: "+v);
         }
         
      } catch(Exception e) {
         // if any error occurs
         e.printStackTrace();
      }
   }
}

Output

Let us compile and run the above program, this will produce the following result(depends on system's free space)−

number of allocated bytes: 62230548480

Example - Usage of File getTotalSpace() method

FileDemo.java

package com.tutorialspoint;

import java.io.File;

public class FileDemo {
   public static void main(String[] args) {
      // Create a File object representing a drive or directory
      File file = new File("C:\\"); // Use "/" for Linux/macOS

      // Get total space in bytes
      long totalSpace = file.getTotalSpace();

      // Convert bytes to gigabytes for better readability
      double totalSpaceGB = totalSpace / (1024.0 * 1024 * 1024);

      // Print total space
      System.out.println("Total space on drive: " + totalSpaceGB + " GB");
   }
}

Output

Let us compile and run the above program, this will produce the following result (depends on system's free space)−

Total space on drive: 500.0 GB

Explanation

• Creating a File Object− The File object is initialized with "C:\\" (for Windows) or "/" (for Linux/macOS). It represents the root directory of the filesystem.

• Using getTotalSpace()− The method returns the total storage capacity in bytes. To make it more readable, the value is converted to gigabytes (GB).

• getTotalSpace() returns the entire storage capacity of the partition, including used and free space.