Java file size
In this article we show several ways how to determine the size of a file in Java.
is a measure of how much data a computer file contains or, alternately, how much storage it consumes. The file size is usually expressed in bytes.
In Java, we can determine the size of a file with File , FileChannel , Files , and Apache Commons’ FileUtils . A a rule of thumb, in new code we should use the Files class.
In our examples, we are going to use the words.txt file located in src/main/resources directory.
Advertisements Java file size with File
The length method of File returns the file size. This is the oldest API to find out the size of a file in Java.
The code example determines the file size using File’s length method.
Java file size with FileChannel
FileChannel has the size method to determine the size of the file.
The code example determines the file size using FileChannel’s size method.
Advertisements Java file size with Files
Files has the size method to determine the size of the file. This is the most recent API and it is recommended for new Java applications.
The code example determines the file size using Files’ size method.
Java file size with FileUtils
In the last example, we determine the file size with Apache Commons’ FileUtils . Its method for finding out the file size is sizeOf .
For this example, we need the commons-io dependency.
The code example determines the file size using Apache Commons’ FileUtils’ sizeOf method.
In this article, we have shown how to determine the size of a file in Java.
Class Files
In most cases, the methods defined here will delegate to the associated file system provider to perform the file operations.
Method Summary
Methods declared in class java.lang.Object
Method Details
newInputStream
The options parameter determines how the file is opened. If no options are present then it is equivalent to opening the file with the READ option. In addition to the READ option, an implementation may also support additional implementation specific options.
newOutputStream
This method opens or creates a file in exactly the manner specified by the newByteChannel method with the exception that the READ option may not be present in the array of options. If no options are present then this method works as if the CREATE , TRUNCATE_EXISTING , and WRITE options are present. In other words, it opens the file for writing, creating the file if it doesn’t exist, or initially truncating an existing regular-file to a size of 0 if it exists.
Usage Examples:
newByteChannel
The options parameter determines how the file is opened. The READ and WRITE options determine if the file should be opened for reading and/or writing. If neither option (or the APPEND option) is present then the file is opened for reading. By default reading or writing commence at the beginning of the file.
In the addition to READ and WRITE , the following options may be present:
| Option | Description |
|---|---|
| APPEND | If this option is present then the file is opened for writing and each invocation of the channel’s write method first advances the position to the end of the file and then writes the requested data. Whether the advancement of the position and the writing of the data are done in a single atomic operation is system-dependent and therefore unspecified. This option may not be used in conjunction with the READ or TRUNCATE_EXISTING options. |
| TRUNCATE_EXISTING | If this option is present then the existing file is truncated to a size of 0 bytes. This option is ignored when the file is opened only for reading. |
| CREATE_NEW | If this option is present then a new file is created, failing if the file already exists or is a symbolic link. When creating a file the check for the existence of the file and the creation of the file if it does not exist is atomic with respect to other file system operations. This option is ignored when the file is opened only for reading. |
| CREATE | If this option is present then an existing file is opened if it exists, otherwise a new file is created. This option is ignored if the CREATE_NEW option is also present or the file is opened only for reading. |
| DELETE_ON_CLOSE | When this option is present then the implementation makes a best effort attempt to delete the file when closed by the close method. If the close method is not invoked then a best effort attempt is made to delete the file when the Java virtual machine terminates. |
| SPARSE | When creating a new file this option is a hint that the new file will be sparse. This option is ignored when not creating a new file. |
| SYNC | Requires that every update to the file’s content or metadata be written synchronously to the underlying storage device. (see Synchronized I/O file integrity). |
| DSYNC | Requires that every update to the file’s content be written synchronously to the underlying storage device. (see Synchronized I/O file integrity). |
An implementation may also support additional implementation specific options.
The attrs parameter is optional file-attributes to set atomically when a new file is created.
In the case of the default provider, the returned seekable byte channel is a FileChannel .
Usage Examples:
newByteChannel
This method opens or creates a file in exactly the manner specified by the newByteChannel method.
newDirectoryStream
When not using the try-with-resources construct, then directory stream’s close method should be invoked after iteration is completed so as to free any resources held for the open directory.
When an implementation supports operations on entries in the directory that execute in a race-free manner then the returned directory stream is a SecureDirectoryStream .
newDirectoryStream
For example, suppose we want to iterate over the files ending with «.java» in a directory:
The globbing pattern is specified by the getPathMatcher method.
When not using the try-with-resources construct, then directory stream’s close method should be invoked after iteration is completed so as to free any resources held for the open directory.
When an implementation supports operations on entries in the directory that execute in a race-free manner then the returned directory stream is a SecureDirectoryStream .
newDirectoryStream
When not using the try-with-resources construct, then directory stream’s close method should be invoked after iteration is completed so as to free any resources held for the open directory.
Where the filter terminates due to an uncaught error or runtime exception then it is propagated to the hasNext or next method. Where an IOException is thrown, it results in the hasNext or next method throwing a DirectoryIteratorException with the IOException as the cause.
When an implementation supports operations on entries in the directory that execute in a race-free manner then the returned directory stream is a SecureDirectoryStream .
Usage Example: Suppose we want to iterate over the files in a directory that are larger than 8K.
createFile
The attrs parameter is optional file-attributes to set atomically when creating the file. Each attribute is identified by its name . If more than one attribute of the same name is included in the array then all but the last occurrence is ignored.
createDirectory
The attrs parameter is optional file-attributes to set atomically when creating the directory. Each attribute is identified by its name . If more than one attribute of the same name is included in the array then all but the last occurrence is ignored.
createDirectories
The attrs parameter is optional file-attributes to set atomically when creating the nonexistent directories. Each file attribute is identified by its name . If more than one attribute of the same name is included in the array then all but the last occurrence is ignored.
If this method fails, then it may do so after creating some, but not all, of the parent directories.
createTempFile
The details as to how the name of the file is constructed is implementation dependent and therefore not specified. Where possible the prefix and suffix are used to construct candidate names in the same manner as the File.createTempFile(String,String,File) method.
As with the File.createTempFile methods, this method is only part of a temporary-file facility. Where used as a work files, the resulting file may be opened using the DELETE_ON_CLOSE option so that the file is deleted when the appropriate close method is invoked. Alternatively, a shutdown-hook , or the File.deleteOnExit() mechanism may be used to delete the file automatically.
The attrs parameter is optional file-attributes to set atomically when creating the file. Each attribute is identified by its name . If more than one attribute of the same name is included in the array then all but the last occurrence is ignored. When no file attributes are specified, then the resulting file may have more restrictive access permissions to files created by the File.createTempFile(String,String,File) method.
createTempFile
This method works in exactly the manner specified by the createTempFile(Path,String,String,FileAttribute[]) method for the case that the dir parameter is the temporary-file directory.
createTempDirectory
The details as to how the name of the directory is constructed is implementation dependent and therefore not specified. Where possible the prefix is used to construct candidate names.
As with the createTempFile methods, this method is only part of a temporary-file facility. A shutdown-hook , or the File.deleteOnExit() mechanism may be used to delete the directory automatically.
The attrs parameter is optional file-attributes to set atomically when creating the directory. Each attribute is identified by its name . If more than one attribute of the same name is included in the array then all but the last occurrence is ignored.
createTempDirectory
This method works in exactly the manner specified by createTempDirectory(Path,String,FileAttribute[]) method for the case that the dir parameter is the temporary-file directory.
createSymbolicLink
The target parameter is the target of the link. It may be an absolute or relative path and may not exist. When the target is a relative path then file system operations on the resulting link are relative to the path of the link.
The attrs parameter is optional attributes to set atomically when creating the link. Each attribute is identified by its name . If more than one attribute of the same name is included in the array then all but the last occurrence is ignored.
Where symbolic links are supported, but the underlying FileStore does not support symbolic links, then this may fail with an IOException . Additionally, some operating systems may require that the Java virtual machine be started with implementation specific privileges to create symbolic links, in which case this method may throw IOException .
createLink
The link parameter locates the directory entry to create. The existing parameter is the path to an existing file. This method creates a new directory entry for the file so that it can be accessed using link as the path. On some file systems this is known as creating a «hard link». Whether the file attributes are maintained for the file or for each directory entry is file system specific and therefore not specified. Typically, a file system requires that all links (directory entries) for a file be on the same file system. Furthermore, on some platforms, the Java virtual machine may require to be started with implementation specific privileges to create hard links or to create links to directories.
delete
An implementation may require to examine the file to determine if the file is a directory. Consequently this method may not be atomic with respect to other file system operations. If the file is a symbolic link then the symbolic link itself, not the final target of the link, is deleted.
If the file is a directory then the directory must be empty. In some implementations a directory has entries for special files or links that are created when the directory is created. In such implementations a directory is considered empty when only the special entries exist. This method can be used with the walkFileTree method to delete a directory and all entries in the directory, or an entire file-tree where required.
On some operating systems it may not be possible to remove a file when it is open and in use by this Java virtual machine or other programs.
deleteIfExists
As with the delete(Path) method, an implementation may need to examine the file to determine if the file is a directory. Consequently this method may not be atomic with respect to other file system operations. If the file is a symbolic link, then the symbolic link itself, not the final target of the link, is deleted.
If the file is a directory then the directory must be empty. In some implementations a directory has entries for special files or links that are created when the directory is created. In such implementations a directory is considered empty when only the special entries exist.
On some operating systems it may not be possible to remove a file when it is open and in use by this Java virtual machine or other programs.
This method copies a file to the target file with the options parameter specifying how the copy is performed. By default, the copy fails if the target file already exists or is a symbolic link, except if the source and target are the same file, in which case the method completes without copying the file. File attributes are not required to be copied to the target file. If symbolic links are supported, and the file is a symbolic link, then the final target of the link is copied. If the file is a directory then it creates an empty directory in the target location (entries in the directory are not copied). This method can be used with the walkFileTree method to copy a directory and all entries in the directory, or an entire file-tree where required.
The options parameter may include any of the following:
| Option | Description |
|---|---|
| REPLACE_EXISTING | If the target file exists, then the target file is replaced if it is not a non-empty directory. If the target file exists and is a symbolic link, then the symbolic link itself, not the target of the link, is replaced. |
| COPY_ATTRIBUTES | Attempts to copy the file attributes associated with this file to the target file. The exact file attributes that are copied is platform and file system dependent and therefore unspecified. Minimally, the last-modified-time is copied to the target file if supported by both the source and target file stores. Copying of file timestamps may result in precision loss. |
| NOFOLLOW_LINKS | Symbolic links are not followed. If the file is a symbolic link, then the symbolic link itself, not the target of the link, is copied. It is implementation specific if file attributes can be copied to the new link. In other words, the COPY_ATTRIBUTES option may be ignored when copying a symbolic link. |
An implementation of this interface may support additional implementation specific options.
Copying a file is not an atomic operation. If an IOException is thrown, then it is possible that the target file is incomplete or some of its file attributes have not been copied from the source file. When the REPLACE_EXISTING option is specified and the target file exists, then the target file is replaced. The check for the existence of the file and the creation of the new file may not be atomic with respect to other file system activities.
Usage Example: Suppose we want to copy a file into a directory, giving it the same file name as the source file:
By default, this method attempts to move the file to the target file, failing if the target file exists except if the source and target are the same file, in which case this method has no effect. If the file is a symbolic link then the symbolic link itself, not the target of the link, is moved. This method may be invoked to move an empty directory. In some implementations a directory has entries for special files or links that are created when the directory is created. In such implementations a directory is considered empty when only the special entries exist. When invoked to move a directory that is not empty then the directory is moved if it does not require moving the entries in the directory. For example, renaming a directory on the same FileStore will usually not require moving the entries in the directory. When moving a directory requires that its entries be moved then this method fails (by throwing an IOException ). To move a file tree may involve copying rather than moving directories and this can be done using the copy method in conjunction with the Files.walkFileTree utility method.
The options parameter may include any of the following:
| Option | Description |
|---|---|
| REPLACE_EXISTING | If the target file exists, then the target file is replaced if it is not a non-empty directory. If the target file exists and is a symbolic link, then the symbolic link itself, not the target of the link, is replaced. |
| ATOMIC_MOVE | The move is performed as an atomic file system operation and all other options are ignored. If the target file exists then it is implementation specific if the existing file is replaced or this method fails by throwing an IOException . If the move cannot be performed as an atomic file system operation then AtomicMoveNotSupportedException is thrown. This can arise, for example, when the target location is on a different FileStore and would require that the file be copied, or target location is associated with a different provider to this object. |
An implementation of this interface may support additional implementation specific options.
Moving a file will copy the last-modified-time to the target file if supported by both source and target file stores. Copying of file timestamps may result in precision loss. An implementation may also attempt to copy other file attributes but is not required to fail if the file attributes cannot be copied. When the move is performed as a non-atomic operation, and an IOException is thrown, then the state of the files is not defined. The original file and the target file may both exist, the target file may be incomplete or some of its file attributes may not been copied from the original file.
Usage Examples: Suppose we want to rename a file to «newname», keeping the file in the same directory: Alternatively, suppose we want to move a file to new directory, keeping the same file name, and replacing any existing file of that name in the directory:
readSymbolicLink
If the file system supports symbolic links then this method is used to read the target of the link, failing if the file is not a symbolic link. The target of the link need not exist. The returned Path object will be associated with the same file system as link .
getFileStore
Once a reference to the FileStore is obtained it is implementation specific if operations on the returned FileStore , or FileStoreAttributeView objects obtained from it, continue to depend on the existence of the file. In particular the behavior is not defined for the case that the file is deleted or moved to a different file store.
isSameFile
If both Path objects are equal then this method returns true without checking if the file exists. If the two Path objects are associated with different providers then this method returns false . Otherwise, this method checks if both Path objects locate the same file, and depending on the implementation, may require to open or access both files.
- It is reflexive: for Path f , isSameFile(f,f) should return true .
- It is symmetric: for two Paths f and g , isSameFile(f,g) will equal isSameFile(g,f) .
- It is transitive: for three Paths f , g , and h , if isSameFile(f,g) returns true and isSameFile(g,h) returns true , then isSameFile(f,h) will return true .
mismatch
- The two paths locate the same file, even if two equal paths locate a file does not exist, or
- The two files are the same size, and every byte in the first file is identical to the corresponding byte in the second file.
- The position of the first mismatched byte, or
- The size of the smaller file (in bytes) when the files are different sizes and every byte of the smaller file is identical to the corresponding byte of the larger file.
This method may not be atomic with respect to other file system operations. This method is always reflexive (for Path f , mismatch(f,f) returns -1L ). If the file system and files remain static, then this method is symmetric (for two Paths f and g , mismatch(f,g) will return the same value as mismatch(g,f) ).
isHidden
Depending on the implementation this method may require to access the file system to determine if the file is considered hidden.
probeContentType
This method uses the installed FileTypeDetector implementations to probe the given file to determine its content type. Each file type detector’s probeContentType is invoked, in turn, to probe the file type. If the file is recognized then the content type is returned. If the file is not recognized by any of the installed file type detectors then a system-default file type detector is invoked to guess the content type.
A given invocation of the Java virtual machine maintains a system-wide list of file type detectors. Installed file type detectors are loaded using the service-provider loading facility defined by the ServiceLoader class. Installed file type detectors are loaded using the system class loader. If the system class loader cannot be found then the platform class loader is used. File type detectors are typically installed by placing them in a JAR file on the application class path, the JAR file contains a provider-configuration file named java.nio.file.spi.FileTypeDetector in the resource directory META-INF/services , and the file lists one or more fully-qualified names of concrete subclass of FileTypeDetector that have a zero argument constructor. If the process of locating or instantiating the installed file type detectors fails then an unspecified error is thrown. The ordering that installed providers are located is implementation specific.
The return value of this method is the string form of the value of a Multipurpose Internet Mail Extension (MIME) content type as defined by RFC 2045: Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies. The string is guaranteed to be parsable according to the grammar in the RFC.
getFileAttributeView
A file attribute view provides a read-only or updatable view of a set of file attributes. This method is intended to be used where the file attribute view defines type-safe methods to read or update the file attributes. The type parameter is the type of the attribute view required and the method returns an instance of that type if supported. The BasicFileAttributeView type supports access to the basic attributes of a file. Invoking this method to select a file attribute view of that type will always return an instance of that class.
The options array may be used to indicate how symbolic links are handled by the resulting file attribute view for the case that the file is a symbolic link. By default, symbolic links are followed. If the option NOFOLLOW_LINKS is present then symbolic links are not followed. This option is ignored by implementations that do not support symbolic links.
Usage Example: Suppose we want read or set a file’s ACL, if supported:
readAttributes
The type parameter is the type of the attributes required and this method returns an instance of that type if supported. All implementations support a basic set of file attributes and so invoking this method with a type parameter of BasicFileAttributes.class will not throw UnsupportedOperationException .
The options array may be used to indicate how symbolic links are handled for the case that the file is a symbolic link. By default, symbolic links are followed and the file attribute of the final target of the link is read. If the option NOFOLLOW_LINKS is present then symbolic links are not followed.
It is implementation specific if all file attributes are read as an atomic operation with respect to other file system operations.
Usage Example: Suppose we want to read a file’s attributes in bulk: Alternatively, suppose we want to read file’s POSIX attributes without following symbolic links:
setAttribute
The attribute parameter identifies the attribute to be set and takes the form:
view-name is the name of a FileAttributeView that identifies a set of file attributes. If not specified then it defaults to «basic» , the name of the file attribute view that identifies the basic set of file attributes common to many file systems. attribute-name is the name of the attribute within the set.
The options array may be used to indicate how symbolic links are handled for the case that the file is a symbolic link. By default, symbolic links are followed and the file attribute of the final target of the link is set. If the option NOFOLLOW_LINKS is present then symbolic links are not followed.
Usage Example: Suppose we want to set the DOS «hidden» attribute:
getAttribute
The attribute parameter identifies the attribute to be read and takes the form:
view-name is the name of a FileAttributeView that identifies a set of file attributes. If not specified then it defaults to «basic» , the name of the file attribute view that identifies the basic set of file attributes common to many file systems. attribute-name is the name of the attribute.
The options array may be used to indicate how symbolic links are handled for the case that the file is a symbolic link. By default, symbolic links are followed and the file attribute of the final target of the link is read. If the option NOFOLLOW_LINKS is present then symbolic links are not followed.
Usage Example: Suppose we require the user ID of the file owner on a system that supports a » unix » view:
readAttributes
The attributes parameter identifies the attributes to be read and takes the form:
view-name is the name of a FileAttributeView that identifies a set of file attributes. If not specified then it defaults to «basic» , the name of the file attribute view that identifies the basic set of file attributes common to many file systems.
The attribute-list component is a comma separated list of one or more names of attributes to read. If the list contains the value «*» then all attributes are read. Attributes that are not supported are ignored and will not be present in the returned map. It is implementation specific if all attributes are read as an atomic operation with respect to other file system operations.
The following examples demonstrate possible values for the attributes parameter:
| Example | Description |
|---|---|
| «*» | Read all basic-file-attributes . |
| «size,lastModifiedTime,lastAccessTime» | Reads the file size, last modified time, and last access time attributes. |
| «posix:*» | Read all POSIX-file-attributes . |
| «posix:permissions,owner,size» | Reads the POSIX file permissions, owner, and file size. |
The options array may be used to indicate how symbolic links are handled for the case that the file is a symbolic link. By default, symbolic links are followed and the file attribute of the final target of the link is read. If the option NOFOLLOW_LINKS is present then symbolic links are not followed.
getPosixFilePermissions
The path parameter is associated with a FileSystem that supports the PosixFileAttributeView . This attribute view provides access to file attributes commonly associated with files on file systems used by operating systems that implement the Portable Operating System Interface (POSIX) family of standards.
The options array may be used to indicate how symbolic links are handled for the case that the file is a symbolic link. By default, symbolic links are followed and the file attribute of the final target of the link is read. If the option NOFOLLOW_LINKS is present then symbolic links are not followed.
setPosixFilePermissions
The path parameter is associated with a FileSystem that supports the PosixFileAttributeView . This attribute view provides access to file attributes commonly associated with files on file systems used by operating systems that implement the Portable Operating System Interface (POSIX) family of standards.
getOwner
The path parameter is associated with a file system that supports FileOwnerAttributeView . This file attribute view provides access to a file attribute that is the owner of the file.
setOwner
The path parameter is associated with a file system that supports FileOwnerAttributeView . This file attribute view provides access to a file attribute that is the owner of the file.
Usage Example: Suppose we want to make «joe» the owner of a file:
isSymbolicLink
Where it is required to distinguish an I/O exception from the case that the file is not a symbolic link then the file attributes can be read with the readAttributes method and the file type tested with the BasicFileAttributes.isSymbolicLink() method.
isDirectory
The options array may be used to indicate how symbolic links are handled for the case that the file is a symbolic link. By default, symbolic links are followed and the file attribute of the final target of the link is read. If the option NOFOLLOW_LINKS is present then symbolic links are not followed.
Where it is required to distinguish an I/O exception from the case that the file is not a directory then the file attributes can be read with the readAttributes method and the file type tested with the BasicFileAttributes.isDirectory() method.
isRegularFile
The options array may be used to indicate how symbolic links are handled for the case that the file is a symbolic link. By default, symbolic links are followed and the file attribute of the final target of the link is read. If the option NOFOLLOW_LINKS is present then symbolic links are not followed.
Where it is required to distinguish an I/O exception from the case that the file is not a regular file then the file attributes can be read with the readAttributes method and the file type tested with the BasicFileAttributes.isRegularFile() method.
getLastModifiedTime
The options array may be used to indicate how symbolic links are handled for the case that the file is a symbolic link. By default, symbolic links are followed and the file attribute of the final target of the link is read. If the option NOFOLLOW_LINKS is present then symbolic links are not followed.
setLastModifiedTime
Usage Example: Suppose we want to set the last modified time to the current time:
exists
The options parameter may be used to indicate how symbolic links are handled for the case that the file is a symbolic link. By default, symbolic links are followed. If the option NOFOLLOW_LINKS is present then symbolic links are not followed.
Note that the result of this method is immediately outdated. If this method indicates the file exists then there is no guarantee that a subsequent access will succeed. Care should be taken when using this method in security sensitive applications.
notExists
The options parameter may be used to indicate how symbolic links are handled for the case that the file is a symbolic link. By default, symbolic links are followed. If the option NOFOLLOW_LINKS is present then symbolic links are not followed.
Note that this method is not the complement of the exists method. Where it is not possible to determine if a file exists or not then both methods return false . As with the exists method, the result of this method is immediately outdated. If this method indicates the file does exist then there is no guarantee that a subsequent attempt to create the file will succeed. Care should be taken when using this method in security sensitive applications.
isReadable
Note that the result of this method is immediately outdated, there is no guarantee that a subsequent attempt to open the file for reading will succeed (or even that it will access the same file). Care should be taken when using this method in security sensitive applications.
isWritable
Note that result of this method is immediately outdated, there is no guarantee that a subsequent attempt to open the file for writing will succeed (or even that it will access the same file). Care should be taken when using this method in security sensitive applications.
isExecutable
Depending on the implementation, this method may require to read file permissions, access control lists, or other file attributes in order to check the effective access to the file. Consequently, this method may not be atomic with respect to other file system operations.
Note that the result of this method is immediately outdated, there is no guarantee that a subsequent attempt to execute the file will succeed (or even that it will access the same file). Care should be taken when using this method in security sensitive applications.
walkFileTree
This method walks a file tree rooted at a given starting file. The file tree traversal is depth-first with the given FileVisitor invoked for each file encountered. File tree traversal completes when all accessible files in the tree have been visited, or a visit method returns a result of TERMINATE . Where a visit method terminates due an IOException , an uncaught error, or runtime exception, then the traversal is terminated and the error or exception is propagated to the caller of this method.
For each file encountered this method attempts to read its BasicFileAttributes . If the file is not a directory then the visitFile method is invoked with the file attributes. If the file attributes cannot be read, due to an I/O exception, then the visitFileFailed method is invoked with the I/O exception.
Where the file is a directory, and the directory could not be opened, then the visitFileFailed method is invoked with the I/O exception, after which, the file tree walk continues, by default, at the next sibling of the directory.
Where the directory is opened successfully, then the entries in the directory, and their descendants are visited. When all entries have been visited, or an I/O error occurs during iteration of the directory, then the directory is closed and the visitor’s postVisitDirectory method is invoked. The file tree walk then continues, by default, at the next sibling of the directory.
By default, symbolic links are not automatically followed by this method. If the options parameter contains the FOLLOW_LINKS option then symbolic links are followed. When following links, and the attributes of the target cannot be read, then this method attempts to get the BasicFileAttributes of the link. If they can be read then the visitFile method is invoked with the attributes of the link (otherwise the visitFileFailed method is invoked as specified above).
If the options parameter contains the FOLLOW_LINKS option then this method keeps track of directories visited so that cycles can be detected. A cycle arises when there is an entry in a directory that is an ancestor of the directory. Cycle detection is done by recording the file-key of directories, or if file keys are not available, by invoking the isSameFile method to test if a directory is the same file as an ancestor. When a cycle is detected it is treated as an I/O error, and the visitFileFailed method is invoked with an instance of FileSystemLoopException .
The maxDepth parameter is the maximum number of levels of directories to visit. A value of 0 means that only the starting file is visited, unless denied by the security manager. A value of MAX_VALUE may be used to indicate that all levels should be visited. The visitFile method is invoked for all files, including directories, encountered at maxDepth , unless the basic file attributes cannot be read, in which case the visitFileFailed method is invoked.
If a visitor returns a result of null then NullPointerException is thrown.
When a security manager is installed and it denies access to a file (or directory), then it is ignored and the visitor is not invoked for that file (or directory).
walkFileTree
This method works as if invoking it were equivalent to evaluating the expression:
newBufferedReader
The Reader methods that read from the file throw IOException if a malformed or unmappable byte sequence is read.
newBufferedReader
This method works as if invoking it were equivalent to evaluating the expression:
newBufferedWriter
The Writer methods to write text throw IOException if the text cannot be encoded using the specified charset.
newBufferedWriter
This method works as if invoking it were equivalent to evaluating the expression:
By default, the copy fails if the target file already exists or is a symbolic link. If the REPLACE_EXISTING option is specified, and the target file already exists, then it is replaced if it is not a non-empty directory. If the target file exists and is a symbolic link, then the symbolic link is replaced. In this release, the REPLACE_EXISTING option is the only option required to be supported by this method. Additional options may be supported in future releases.
If an I/O error occurs reading from the input stream or writing to the file, then it may do so after the target file has been created and after some bytes have been read or written. Consequently the input stream may not be at end of stream and may be in an inconsistent state. It is strongly recommended that the input stream be promptly closed if an I/O error occurs.
This method may block indefinitely reading from the input stream (or writing to the file). The behavior for the case that the input stream is asynchronously closed or the thread interrupted during the copy is highly input stream and file system provider specific and therefore not specified.
Usage example: Suppose we want to capture a web page and save it to a file:
If an I/O error occurs reading from the file or writing to the output stream, then it may do so after some bytes have been read or written. Consequently the output stream may be in an inconsistent state. It is strongly recommended that the output stream be promptly closed if an I/O error occurs.
This method may block indefinitely writing to the output stream (or reading from the file). The behavior for the case that the output stream is asynchronously closed or the thread interrupted during the copy is highly output stream and file system provider specific and therefore not specified.
Note that if the given output stream is Flushable then its flush method may need to invoked after this method completes so as to flush any buffered output.
readAllBytes
Note that this method is intended for simple cases where it is convenient to read all bytes into a byte array. It is not intended for reading in large files.
readString
readString
This method reads all content including the line separators in the middle and/or at the end. The resulting string will contain line separators as they appear in the file.
readAllLines
- \u000D followed by \u000A , CARRIAGE RETURN followed by LINE FEED
- \u000A , LINE FEED
- \u000D , CARRIAGE RETURN
Additional Unicode line terminators may be recognized in future releases.
Note that this method is intended for simple cases where it is convenient to read all lines in a single operation. It is not intended for reading in large files.
readAllLines
This method works as if invoking it were equivalent to evaluating the expression:
write
Usage example: By default the method creates a new file or overwrites an existing file. Suppose you instead want to append bytes to an existing file:
write
The options parameter specifies how the file is created or opened. If no options are present then this method works as if the CREATE , TRUNCATE_EXISTING , and WRITE options are present. In other words, it opens the file for writing, creating the file if it doesn’t exist, or initially truncating an existing regular-file to a size of 0 . The method ensures that the file is closed when all lines have been written (or an I/O error or other runtime exception is thrown). If an I/O error occurs then it may do so after the file has been created or truncated, or after some bytes have been written to the file.
write
This method works as if invoking it were equivalent to evaluating the expression:
writeString
writeString
All characters are written as they are, including the line separators in the char sequence. No extra characters are added.
The options parameter specifies how the file is created or opened. If no options are present then this method works as if the CREATE , TRUNCATE_EXISTING , and WRITE options are present. In other words, it opens the file for writing, creating the file if it doesn’t exist, or initially truncating an existing regular-file to a size of 0 .
The elements of the stream are Path objects that are obtained as if by resolving the name of the directory entry against dir . Some file systems maintain special links to the directory itself and the directory’s parent directory. Entries representing these links are not included.
The stream is weakly consistent. It is thread safe but does not freeze the directory while iterating, so it may (or may not) reflect updates to the directory that occur after returning from this method.
The returned stream contains a reference to an open directory. The directory is closed by closing the stream.
Operating on a closed stream behaves as if the end of stream has been reached. Due to read-ahead, one or more elements may be returned after the stream has been closed.
If an IOException is thrown when accessing the directory after this method has returned, it is wrapped in an UncheckedIOException which will be thrown from the method that caused the access to take place.
The stream walks the file tree as elements are consumed. The Stream returned is guaranteed to have at least one element, the starting file itself. For each file visited, the stream attempts to read its BasicFileAttributes . If the file is a directory and can be opened successfully, entries in the directory, and their descendants will follow the directory in the stream as they are encountered. When all entries have been visited, then the directory is closed. The file tree walk then continues at the next sibling of the directory.
The stream is weakly consistent. It does not freeze the file tree while iterating, so it may (or may not) reflect updates to the file tree that occur after returned from this method.
By default, symbolic links are not automatically followed by this method. If the options parameter contains the FOLLOW_LINKS option then symbolic links are followed. When following links, and the attributes of the target cannot be read, then this method attempts to get the BasicFileAttributes of the link.
If the options parameter contains the FOLLOW_LINKS option then the stream keeps track of directories visited so that cycles can be detected. A cycle arises when there is an entry in a directory that is an ancestor of the directory. Cycle detection is done by recording the file-key of directories, or if file keys are not available, by invoking the isSameFile method to test if a directory is the same file as an ancestor. When a cycle is detected it is treated as an I/O error with an instance of FileSystemLoopException .
The maxDepth parameter is the maximum number of levels of directories to visit. A value of 0 means that only the starting file is visited, unless denied by the security manager. A value of MAX_VALUE may be used to indicate that all levels should be visited.
When a security manager is installed and it denies access to a file (or directory), then it is ignored and not included in the stream.
The returned stream contains references to one or more open directories. The directories are closed by closing the stream.
If an IOException is thrown when accessing the directory after this method has returned, it is wrapped in an UncheckedIOException which will be thrown from the method that caused the access to take place.
This method works as if invoking it were equivalent to evaluating the expression:
The returned stream contains references to one or more open directories. The directories are closed by closing the stream.
This method walks the file tree in exactly the manner specified by the walk method. For each file encountered, the given BiPredicate is invoked with its Path and BasicFileAttributes . The Path object is obtained as if by resolving the relative path against start and is only included in the returned Stream if the BiPredicate returns true. Compare to calling filter on the Stream returned by walk method, this method may be more efficient by avoiding redundant retrieval of the BasicFileAttributes .
The returned stream contains references to one or more open directories. The directories are closed by closing the stream.
If an IOException is thrown when accessing the directory after returned from this method, it is wrapped in an UncheckedIOException which will be thrown from the method that caused the access to take place.
lines
Bytes from the file are decoded into characters using the specified charset and the same line terminators as specified by readAllLines are supported.
The returned stream contains a reference to an open file. The file is closed by closing the stream.
The file contents should not be modified during the execution of the terminal stream operation. Otherwise, the result of the terminal stream operation is undefined.
After this method returns, then any subsequent I/O exception that occurs while reading from the file or when a malformed or unmappable byte sequence is read, is wrapped in an UncheckedIOException that will be thrown from the Stream method that caused the read to take place. In case an IOException is thrown when closing the file, it is also wrapped as an UncheckedIOException .
For non-line-optimal charsets the stream source’s spliterator has poor splitting properties, similar to that of a spliterator associated with an iterator or that associated with a stream returned from BufferedReader.lines() . Poor splitting properties can result in poor parallel stream performance.
For line-optimal charsets the stream source’s spliterator has good splitting properties, assuming the file contains a regular sequence of lines. Good splitting properties can result in good parallel stream performance. The spliterator for a line-optimal charset takes advantage of the charset properties (a line feed or a carriage return being efficient identifiable) such that when splitting it can approximately divide the number of covered lines in half.
lines
The returned stream contains a reference to an open file. The file is closed by closing the stream.
The file contents should not be modified during the execution of the terminal stream operation. Otherwise, the result of the terminal stream operation is undefined.
This method works as if invoking it were equivalent to evaluating the expression:
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2022, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.
Размер файла в Java
В этом кратком руководстве мы узнаем, как получитьsize of a file in Java — с использованием Java 7, новой Java 8 и Apache Common IO.
Наконец, мы также получим удобочитаемое представление размера файла.
2. Стандартный Java IO
Начнем с простого примера расчета размера файла с помощью методаFile.length():
Мы можем проверить нашу реализацию относительно просто:
Обратите внимание, что по умолчанию размеры файлов рассчитываются в байтах.
3. С Java NIO
Далее — давайте посмотрим, как использовать библиотеку NIO, чтобы получить размер файла.
В следующем примере мы воспользуемся APIFileChannel.size(), чтобы получить размер файла в байтах:
4. С Apache Commons IO
Далее — давайте посмотрим, как получить размер файла с помощьюApache Commons IO. В следующем примере мы просто используемFileUtils.sizeOf() для получения размера файла:
Обратите внимание, что для файлов с ограничениями безопасностиFileUtils.sizeOf() сообщит о размере нулевого размера.
5. Удобочитаемый размер
Наконец, давайте посмотрим, как получить более удобочитаемое представление размера файла с помощьюApache Commons IO, а не только размер в байтах:
6. Заключение
В этом руководстве мы проиллюстрировали примеры использования Java и Apache Commons IO для вычисления размера файла в файловой системе.
Реализацию этих примеров можно найти вthe GitHub project — это проект на основе Maven, поэтому его должно быть легко импортировать и запускать как есть.
Get size of folder or file
This returns the length of the file in bytes or 0 if the file does not exist. There is no built-in way to get the size of a folder, you are going to have to walk the directory tree recursively (using the listFiles() method of a file object that represents a directory) and accumulate the directory size for yourself:
WARNING: This method is not sufficiently robust for production use. directory.listFiles() may return null and cause a NullPointerException . Also, it doesn’t consider symlinks and possibly has other failure modes. Use this method.
Using java-7 nio api, calculating the folder size can be done a lot quicker.
Here is a ready to run example that is robust and won’t throw an exception. It will log directories it can’t enter or had trouble traversing. Symlinks are ignored, and concurrent modification of the directory won’t cause more trouble than necessary.
Note that you will need to manually check whether the file is a directory as the method throws an exception if a non-directory is passed to it.
WARNING: This method (as of commons-io 2.4) has a bug and may throw IllegalArgumentException if the directory is concurrently modified.
It would be nicer to use Files::size in the map step but it throws a checked exception.
UPDATE:
You should also be aware that this can throw an exception if some of the files/folders are not accessible. See this question and another solution using Guava.
For Java 8 this is one right way to do it:
It is important to filter out all directories, because the length method isn’t guaranteed to be 0 for directories.
At least this code delivers the same size information like Windows Explorer itself does.
Here’s the best way to get a general File’s size (works for directory and non-directory):
Edit: Note that this is probably going to be a time-consuming operation. Don’t run it on the UI thread.
Also, here (taken from https://stackoverflow.com/a/5599842/1696171) is a nice way to get a user-readable String from the long returned:
Note that this doesn’t work for directories, or is not guaranteed to work.
For a directory, what do you want? If it’s the total size of all files underneath it, you can recursively walk children using File.list() and File.isDirectory() and sum their sizes.
The File object has a length method:
If you want to use Java 8 NIO API, the following program will print the size, in bytes, of the directory it is located in.
The calculateSize method is universal for Path objects, so it also works for files. Note that if a file or directory is inaccessible, in this case the returned size of the path object will be 0 .
- Works for Android and Java
- Works for both folders and files
- Checks for null pointer everywhere where needed
- Ignores symbolic link aka shortcuts
- Production ready!
I’ve tested du -c <folderpath> and is 2x faster than nio.Files or recursion
for windows, using java.io this reccursive function is useful.
This is tested and working properly on my end.
After lot of researching and looking into different solutions proposed here at StackOverflow. I finally decided to write my own solution. My purpose is to have no-throw mechanism because I don’t want to crash if the API is unable to fetch the folder size. This method is not suitable for mult-threaded scenario.
First of all I want to check for valid directories while traversing down the file system tree.
Second I do not want my recursive call to go into symlinks (softlinks) and include the size in total aggregate.
Finally my recursion based implementation to fetch the size of the specified directory. Notice the null check for dir.listFiles(). According to javadoc there is a possibility that this method can return null.
Some cream on the cake, the API to get the size of the list Files (might be all of files and folder under root).