Java File Class|Developer.com

Developer.com material and item suggestions are editorially independent. We might earn money when you click links to our partners. Find Out More

Java Programming tutorials

Found in the java.io bundle, the Java File class is Java’s representation of a file or directory site pathname. It includes numerous approaches for dealing with the pathname, erasing and relabeling files, developing brand-new directory sites, noting the contents of a directory site, and figuring out typical characteristics of files and directory sites. This tutorial will cover other elements of the File class consisting of how to instantiate one, the various course types, getting info about a file, noting files, and dealing with files.

How to Produce a File Things in Java

In a tutorial I composed for TechRepublic ( Directory Site Navigation in Java), we passed an outright file course to the builder, as displayed in the following code example:

 Submit file = brand-new File(" C:  My Files");.(* )The code above produces an abstract representation of the Windows "

My Files” folder– likewise described as an abstract pathname Designers can likewise describe a file as follows:

// Utilizing a relative course . Submit linuxFile = brand-new File(“/ Java/myfile. csv”); .// Utilizing an outright course . Submit windowsFile = brand-new File(” F: Java myfile.txt”); .

The

File class has a couple of other fabricators that we did not utilize. Here is a description of those: File( File moms and dad, String kid)

: Develops a brand-new File circumstances from a moms and dad File and a kid pathname string. File( String moms and dad, String kid)
: Develops a brand-new File circumstances from a moms and dad pathname string and a kid pathname string. File( URI uri)
: Develops a brand-new File circumstances by transforming the provided file URI into an abstract pathname. Check Out:

Java Thread Class Java Relative Pathnames

As signified by the name, a

relative pathname is translated through info drawn from some other pathname. This info is gotten from the existing directory site of your program. The relative pathname is then integrated with the existing directory site course in order to discover the asked for file. If you are ever not sure what the existing directory site is, you can learn by calling the System.getProperty() technique: System.getProperty(” user.dir”)

;.(* )How to Get Info about a Java File Things When a developer has actually instantiated a brand-new

File

things, they can acquire a great deal of info about it. Here is a list of approaches that can assist with that: public String getName(): Returns the name of the file or directory site signified by this abstract pathname.

public String getParent(): Returns the pathname string of this abstract pathname’s moms and dad, or null if this pathname does not call a moms and dad directory site.
public File getParentFile(): Returns the abstract pathname of this abstract pathname’s moms and dad, or null if this pathname does not call a moms and dad directory site.
public String getPath(): Converts this abstract pathname into a pathname string.
public boolean isAbsolute(): Tests whether this abstract pathname is outright. Returns real if this abstract pathname is outright, incorrect otherwise.
public String getAbsolutePath(): Returns the outright pathname string of this abstract pathname.
public String getCanonicalPath(): Returns the Canonical pathname of this abstract pathname. If the pathname of the file things is Canonical then it just returns the course of the existing file things. The Canonical course is constantly outright and distinct, the function eliminates the ‘
‘ and ‘‘ from the course, if present. public boolean canRead(): Tests whether the application can check out the file signified by this abstract pathname. Returns real if and just if the file defined by this abstract pathname exists and can be checked out by the application, or incorrect otherwise.
public boolean canWrite(): Tests whether the application can customize to the file signified by this abstract pathname. Returns
real if– and just if– the file system in fact includes a file signified by this abstract pathname and the application is enabled to compose to the file; incorrect otherwise. public boolean exists(): Tests whether the file or directory site signified by this abstract pathname exists. Returns
real if and just if the file or directory site signified by this abstract pathname exists, or incorrect otherwise. public boolean isDirectory(): Tests whether the file signified by this abstract pathname is a directory site. Returns
real if and just if the file signified by this abstract pathname exists and is a directory site, or incorrect otherwise. public boolean isFile(): Tests whether the file signified by this abstract pathname is a regular file. A file is typical if it is not a directory site and, in addition, pleases other system-dependent requirements. Any non-directory file produced by a Java application is ensured to be a regular file. Returns
real if– and just if– the file signified by this abstract pathname exists and is a regular file, or incorrect otherwise. public long lastModified(): Returns the time that the file signified by this abstract pathname was last customized. Returns a long worth representing the time the file was last customized, determined in milliseconds given that the date (
00:00:00 GMT, January 1, 1970), or 0L if the file does not exist or if an I/O mistake happens. public long length(): Returns the length of the file signified by this abstract pathname, in bytes. The return worth is undefined if this pathname represents a directory site.
public String toString(): Returns the pathname string of this abstract pathname. This is the exact same string returned by the
getPath() technique. This customized variation of the very first program shows a variety of File

residential or commercial properties: bundle com.developer; .
. import java.io.File; .
import java.io.IOException; . . public class GetFileInfoExample { . public fixed space primary( String args) tosses IOException { .// Shop the name of files and directory sites .
// in a variety of Files. .// Do not forget to leave the backslash character! . Submit

 files =brand-new File(" C:  My Files"). listFiles();.
.// Traverse through the files range. for( File file: files) {
.// If a subdirectory is discovered,.// print the name of the subdirectory .
System.out.println(" Is a Directory site?" + file.isDirectory());. System.out.println (" Is a File?"+ file.isFile ()); . if( file.isDirectory() ){.
. System.out.println( "Directory Site:"+ file.getName
()); . } .
else {.// Print the file name . System.out.println(" File:" + file.getName());.} . System.out.println(
" Exists?" + file.exists());. System.out.println( "Moms And Dad:"+ file.getParent());. System.out.println( "Course:"+ file.getPath());. System.out.println( "Is outright?"+ file.isAbsolute());. System.out.println( "Outright course:"+ file.getAbsolutePath());
. System.out.println( "Caninocal course:"+ file.getCanonicalPath());
. System.out.println( "Is legible?"+ file.canRead());. System.out.println (" Is writable?"+ file.canWrite());. System.out.println (" Is executable?"+ file.canExecute() )
; .
System.out.println(" Last customized: "+ file.lastModified()); . System.out.println (" Length( in bytes):"
+ file.length() ); .
}
.
}
.}
.[] Here are the residential or commercial properties of the very first number of(*
) Files[]:(* )// Submit 1: . Is a Directory site? real .
Is a File? incorrect . Directory site:AAMS . Exists? real. Moms and dad: I: My Files .
Course: I: My DocumentsAAMS .
Is outright? real .
Outright course: I: My DocumentsAAMS .
Caninocal course: I: My DocumentsAAMS .
Is legible? real . Is writable? real .
Is executable? real . Last customized:
1588454396994 . Length (in bytes): 0 . Is a Directory site? real .
Is a File? incorrect . Directory Site: Addictive Drums. Exists? real. Moms and dad: I: My Files .
Course: I: My DocumentsAddictive Drums .
Is outright? real .
Outright course: I: My DocumentsAddictive Drums .
Caninocal course: I:My DocumentsAddictive Drums . Is legible? real. Is writable? real .
Is executable? real .
Last customized: 1075183575015 .
Length( in bytes ): 0 .// File 2: .
Is a Directory site? real .
Is a File? incorrect 
. Directory site: Angular .
Exists? real. Moms and dad: I: My Files. Course: I: My DocumentsAngular .
Is outright? real. Outright course: I: My DocumentsAngular .
Caninocal course: I: My DocumentsAngular .
Is legible? real . Is writable? real . Is executable? real 
. Last customized: 1535211679142 . Length( in bytes): 0 .
Is a Directory site? real . Is a File? incorrect .
Directory site: angular-starter . Exists? real. Moms and dad: I: My Files .
Course: I: My Documentsangular-starter .
Is outright? real . Outright course: I: My Documentsangular-starter .
Caninocal course: I: My Documentsangular-starter . Is legible? real . Is writable? real . Is executable? real . Last customized: 1539441641426 . Length( in bytes): 0 .

Check Out: IntelliJ Concept Evaluation (* )Noting Files in Java (* )Obviously, we have actually currently seen listFiles()

 in action in both of the above examples. For efficiency, here are all of the

File(* )approaches that return a list of files or pathnames: public String

list ()

: Returns a variety of strings calling the files and directory sites in the directory site signified by this abstract pathname. public String list( FilenameFilter filter): Returns a variety of strings calling the files and directory sites in the directory site signified by this abstract pathname that please the defined filter. public File

listFiles()[]: Returns a variety of abstract pathnames representing the files in the directory site signified by this abstract pathname. public File
listFiles( FileFilter filter)[]: Returns a variety of abstract pathnames representing the files and directory sites in the directory site signified by this abstract pathname that please the defined filter. How to Deal With Files in Java
The Java [] File class likewise includes a variety of approaches for developing a physical file or directory site, along with for customizing and erasing them. They are noted below:
public boolean createNewFile() tosses IOException[]: Atomically produces a brand-new, empty file called by this abstract pathname if and just if a file with this name does not yet exist. Returns real

if the called file does not exist and was effectively produced;

incorrect if the called file currently exists. public boolean erase()

: Deletes the file or directory site signified by this abstract pathname. If this pathname represents a directory site, then the directory site should be empty in order to be erased. Returns real if and just if the file or directory site is effectively erased, or incorrect otherwise. public space deleteOnExit()
: Demands that the file or directory site signified by this abstract pathname be erased when the virtual device ends. public boolean mkdir(): Develops the directory site called by this abstract pathname. Returns real if and just if the directory site was produced, or incorrect
otherwise. public boolean mkdirs()
: Develops the directory site called by this abstract pathname, consisting of any essential however nonexistent moms and dad directory sites. Returns real if and just if the directory site was produced, together with all essential moms and dad directory sites, or incorrect otherwise. public boolean renameTo( File dest)
: Relabels the file signified by this abstract pathname. Returns real if and just if the relabeling been successful, or incorrect otherwise. public boolean setLastModified( very long time)
: Sets the last-modified time of the file or directory site called by this abstract pathname. Returns real if and just if the operation was successful, or incorrect otherwise. public boolean setReadOnly()
: Marks the file or directory site called by this abstract pathname so that just check out operations are enabled. Returns real if and just if the operation was successful, or incorrect otherwise. public fixed File createTempFile( String prefix, String suffix, File directory site) tosses IOException
: Develops a brand-new empty file in the defined directory site, utilizing the provided prefix and suffix strings to produce its name. Returns an abstract pathname representing a newly-created empty file. public fixed File createTempFile( String prefix, String suffix) tosses IOException: Develops an empty file in the default temporary-file directory site, utilizing the provided prefix and suffix to produce its name. Invoking this technique is comparable to conjuring up createTempFile( prefix, suffix, null) Returns abstract pathname representing a newly-created empty file. public int compareTo( File pathname)
: Compares 2 abstract pathnames lexicographically. Returns absolutely no if the argument amounts to this abstract pathname, a worth less than absolutely no if this abstract pathname is lexicographically (i.e. by dictionary order) less than the argument, or a worth higher than absolutely no if this abstract pathname is lexicographically higher than the argument. public int compareTo( Things o)
: Compares this abstract pathname to another things. Returns absolutely no if the argument amounts to this abstract pathname, a worth less than absolutely no if this abstract pathname is lexicographically less than the argument, or a worth higher than absolutely no if this abstract pathname is lexicographically higher than the argument. public boolean equates to( Object obj): Tests this abstract pathname for equality with the provided things. Returns real
if– and just if– the argument is not null and is an abstract pathname that represents the exact same file or directory site as this abstract pathname. Let’s provide a few of these approaches a shot. Here is an example program that produces a file in the existing working directory site, relabels it, and after that tries to erase both the initial and relabelled file from the drive:
bundle com.developer; .
. import java.io.File; . import java.io.IOException; .
. public class FileOperationsExample {
. public fixed space primary( String args) { . attempt { .// Producing a things of a file . Submit testFile= brand-new File(” FileOperationsExample.
txt”); . if( testFile.createNewFile() ){ .
. System.out.println (” Submit” +testFile.getName()+ ”
is produced effectively.”); . System.out.println( ”
Course is”+ testFile.getAbsolutePath() ); .
} else { . System.out.println(” File is currently exist in the directory site.
“); .} . Submit renamedTestFile= brand-new File(“(* )
FileOperationsExampleRenamed. txt “); . boolean relabelled= testFile.renameTo( renamedTestFile); . if( relabelled ){ .
System.out.println(” File has actually been relabelled to” + testFile.getName()); .} else { . System.out.println(” Might not relabel the File. ”
); .} . . boolean isDeleted =renamedTestFile.delete(); . if( isDeleted) { . System.out.println(” The relabelled test file has actually been effectively erased.
“); .
} else { . System.out.println(” Might not erase the relabelled test file.
“); .} . .// This will stop working due to the fact that the testFile has actually been relabelled .
isDeleted = testFile.delete(); . if( isDeleted) { . System.out.println (” The test file has actually been effectively erased.
“); .} else { . System.out.println(” Might not erase the test file.”); .}
.
} catch(
IOException exception) { . System.out.println( “An unanticipated mistake is taken place.”); . exception.printStackTrace(); .} .} .} . Although we might erase the relabelled file, the

erase()

 stopped working on the initial file given that it no longer exists![] Submit FileOperationsExample.txt is produced effectively. . Course is I: article-workspace directoryNavigation FileOperationsExample.txt. Submit has actually been relabelled to FileOperationsExample.txt. The relabelled test file has actually been effectively erased.. Might not erase the test file..
 Last Ideas on the Java File Class In this shows tutorial, we discovered how to instantiate a

File, about the various course types, how to get info about a File

, list  Files, and dealing with

Files

You my have actually observed that the File class does not include any approaches for reading or composing to a file. Those become part of numerous other classes that are arranged by file type, i.e. text versus binary, and how they check out and/or compose to it, i.e. one line at a time, utilizing a buffer, or simultaneously. Check Out: Leading Java Frameworks