| public class java.io File
|
Java SE 6 |
User interfaces and operating systems use system-dependent pathname strings to name files and directories. This class presents an abstract, system-independent view of hierarchical pathnames. An abstract pathname has two components:
"/" for the UNIX root
directory, or "\\\\" for a Microsoft Windows UNC pathname, and
The conversion of a pathname string to or from an abstract pathname is
inherently system-dependent. When an abstract pathname is converted into a
pathname string, each name is separated from the next by a single copy of
the default separator character. The default name-separator
character is defined by the system property file.separator, and
is made available in the public static fields and #separator of this class.
When a pathname string is converted into an abstract pathname, the names
within it may be separated by the default name-separator character or by any
other name-separator character that is supported by the underlying system.
#separatorChar
A pathname, whether abstract or in string form, may be either
absolute or relative. An absolute pathname is complete in
that no other information is required in order to locate the file that it
denotes. A relative pathname, in contrast, must be interpreted in terms of
information taken from some other pathname. By default the classes in the
java.io package always resolve relative pathnames against the
current user directory. This directory is named by the system property
user.dir, and is typically the directory in which the Java
virtual machine was invoked.
The parent of an abstract pathname may be obtained by invoking
the #getParent method of this class and consists of the pathname's
prefix and each name in the pathname's name sequence except for the last.
Each directory's absolute pathname is an ancestor of any File
object with an absolute abstract pathname which begins with the directory's
absolute pathname. For example, the directory denoted by the abstract
pathname "/usr" is an ancestor of the directory denoted by the
pathname "/usr/local/bin".
The prefix concept is used to handle root directories on UNIX platforms, and drive specifiers, root directories and UNC pathnames on Microsoft Windows platforms, as follows:
"/". Relative pathnames have no prefix. The abstract pathname
denoting the root directory has the prefix "/" and an empty
name sequence.
":" and
possibly followed by "\\" if the pathname is absolute. The
prefix of a UNC pathname is "\\\\"; the hostname and the share
name are the first two names in the name sequence. A relative pathname that
does not specify a drive has no prefix.
Instances of this class may or may not denote an actual file-system object such as a file or a directory. If it does denote such an object then that object resides in a partition. A partition is an operating system-specific portion of storage for a file system. A single storage device (e.g. a physical disk-drive, flash memory, CD-ROM) may contain multiple partitions. The object, if any, will reside on the partition named by some ancestor of the absolute form of this pathname.
A file system may implement restrictions to certain operations on the actual file-system object, such as reading, writing, and executing. These restrictions are collectively known as access permissions. The file system may have multiple sets of access permissions on a single object. For example, one set may apply to the object's owner, and another may apply to all other users. The access permissions on an object may cause some methods in this class to fail.
Instances of the File class are immutable; that is, once
created, the abstract pathname represented by a File object
will never change.
| version | 1.139, 06/20/06 |
| since | JDK1.0 |
| Fields | |||
|---|---|---|---|
| final public static char | separatorChar Details
The system-dependent default name-separator character. This field is
initialized to contain the first character of the value of the system
property file.separator. On UNIX systems the value of this
field is '/'; on Microsoft Windows systems it is '\\'.
| ||
| final public static String | separator The system-dependent default name-separator character, represented as a string for convenience. This string contains a single character, namely .
| ||
| final public static char | pathSeparatorChar Details
The system-dependent path-separator character. This field is
initialized to contain the first character of the value of the system
property path.separator. This character is used to
separate filenames in a sequence of files given as a path list.
On UNIX systems, this character is ':'; on Microsoft Windows systems it
is ';'.
| ||
| final public static String | pathSeparator The system-dependent path-separator character, represented as a string for convenience. This string contains a single character, namely .
| ||
| Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public | File(String pathname) Details
Creates a new File instance by converting the given
pathname string into an abstract pathname. If the given string is
the empty string, then the result is the empty abstract pathname.
| ||||||||||
| public | File(String parent, String child) Details
Creates a new File instance from a parent pathname string
and a child pathname string.
If Otherwise the
| ||||||||||
| public | File(File parent, String child) Details
Creates a new File instance from a parent abstract
pathname and a child pathname string.
If Otherwise the
| ||||||||||
| public | File(URI uri) Details
Creates a new File instance by converting the given
file: URI into an abstract pathname.
The exact form of a file: URI is system-dependent, hence the transformation performed by this constructor is also system-dependent. For a given abstract pathname f it is guaranteed that new File( f.so long as the original abstract pathname, the URI, and the new abstract pathname are all created in (possibly different invocations of) the same Java virtual machine. This relationship typically does not hold, however, when a file: URI that is created in a virtual machine on one operating system is converted into an abstract pathname in a virtual machine on a different operating system.
| ||||||||||
| Methods | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| public boolean | canExecute() Details
Tests whether the application can execute the file denoted by this
abstract pathname.
| ||||||||||||||||
| public boolean | canRead() Details
Tests whether the application can read the file denoted by this
abstract pathname.
| ||||||||||||||||
| public boolean | canWrite() Details
Tests whether the application can modify the file denoted by this
abstract pathname.
| ||||||||||||||||
| public int | compareTo(File pathname) Details
Compares two abstract pathnames lexicographically. The ordering
defined by this method depends upon the underlying system. On UNIX
systems, alphabetic case is significant in comparing pathnames; on Microsoft Windows
systems it is not.
| ||||||||||||||||
| public boolean | createNewFile() throws IOException Details
Atomically creates a new, empty file named by this abstract pathname if
and only if a file with this name does not yet exist. The check for the
existence of the file and the creation of the file if it does not exist
are a single operation that is atomic with respect to all other
filesystem activities that might affect the file.
Note: this method should not be used for file-locking, as
the resulting protocol cannot be made to work reliably. The
| ||||||||||||||||
| public static File | createTempFile(String prefix, String suffix, File directory) throws IOException Details
Creates a new empty file in the specified directory, using the given prefix and suffix strings to generate its name. If this method returns successfully then it is guaranteed that:
method.
The To create the new file, the prefix and the suffix may first be
adjusted to fit the limitations of the underlying platform. If the
prefix is too long then it will be truncated, but its first three
characters will always be preserved. If the suffix is too long then it
too will be truncated, but if it begins with a period character
( If the
| ||||||||||||||||
| public static File | createTempFile(String prefix, String suffix) throws IOException Details
Creates an empty file in the default temporary-file directory, using
the given prefix and suffix to generate its name. Invoking this method
is equivalent to invoking .
| ||||||||||||||||
| public boolean | delete() Details
Deletes the file or directory denoted by this abstract pathname. If
this pathname denotes a directory, then the directory must be empty in
order to be deleted.
| ||||||||||||||||
| public void | deleteOnExit() Details
Requests that the file or directory denoted by this abstract
pathname be deleted when the virtual machine terminates.
Files (or directories) are deleted in the reverse order that
they are registered. Invoking this method to delete a file or
directory that is already registered for deletion has no effect.
Deletion will be attempted only for normal termination of the
virtual machine, as defined by the Java Language Specification.
Once deletion has been requested, it is not possible to cancel the request. This method should therefore be used with care.
Note: this method should not be used for file-locking, as
the resulting protocol cannot be made to work reliably. The
| ||||||||||||||||
| public boolean | equals(Object obj) Details
Tests this abstract pathname for equality with the given object.
Returns true if and only if the argument is not
null and is an abstract pathname that denotes the same file
or directory as this abstract pathname. Whether or not two abstract
pathnames are equal depends upon the underlying system. On UNIX
systems, alphabetic case is significant in comparing pathnames; on Microsoft Windows
systems it is not.
| ||||||||||||||||
| public boolean | exists() Details
Tests whether the file or directory denoted by this abstract pathname
exists.
| ||||||||||||||||
| public int | hashCode() Details
Computes a hash code for this abstract pathname. Because equality of
abstract pathnames is inherently system-dependent, so is the computation
of their hash codes. On UNIX systems, the hash code of an abstract
pathname is equal to the exclusive or of the hash code
of its pathname string and the decimal value
1234321. On Microsoft Windows systems, the hash
code is equal to the exclusive or of the hash code of
its pathname string converted to lower case and the decimal
value 1234321. Locale is not taken into account on
lowercasing the pathname string.
| ||||||||||||||||
| public long | lastModified() Details
Returns the time that the file denoted by this abstract pathname was
last modified.
| ||||||||||||||||
| public long | length() Details
Returns the length of the file denoted by this abstract pathname.
The return value is unspecified if this pathname denotes a directory.
| ||||||||||||||||
| public String[] | list() Details
Returns an array of strings naming the files and directories in the
directory denoted by this abstract pathname.
If this abstract pathname does not denote a directory, then this
method returns There is no guarantee that the name strings in the resulting array will appear in any specific order; they are not, in particular, guaranteed to appear in alphabetical order.
| ||||||||||||||||
| public String[] | list(FilenameFilter filter) Details
Returns an array of strings naming the files and directories in the
directory denoted by this abstract pathname that satisfy the specified
filter. The behavior of this method is the same as that of the
method, except that the strings in the
returned array must satisfy the filter. If the given
filter is null then all names are accepted.
Otherwise, a name satisfies the filter if and only if the value
true results when the method of the filter is invoked on this
abstract pathname and the name of a file or directory in the directory
that it denotes.
| ||||||||||||||||
| public File[] | listFiles() Details
Returns an array of abstract pathnames denoting the files in the
directory denoted by this abstract pathname.
If this abstract pathname does not denote a directory, then this
method returns There is no guarantee that the name strings in the resulting array will appear in any specific order; they are not, in particular, guaranteed to appear in alphabetical order.
| ||||||||||||||||
| public File[] | listFiles(FilenameFilter filter) Details
Returns an array of abstract pathnames denoting the files and
directories in the directory denoted by this abstract pathname that
satisfy the specified filter. The behavior of this method is the
same as that of the method, except
that the pathnames in the returned array must satisfy the filter.
If the given filter is null then all
pathnames are accepted. Otherwise, a pathname satisfies the filter
if and only if the value true results when the
method of the filter is
invoked on this abstract pathname and the name of a file or
directory in the directory that it denotes.
| ||||||||||||||||
| public File[] | listFiles(FileFilter filter) Details
Returns an array of abstract pathnames denoting the files and
directories in the directory denoted by this abstract pathname that
satisfy the specified filter. The behavior of this method is the
same as that of the method, except
that the pathnames in the returned array must satisfy the filter.
If the given filter is null then all
pathnames are accepted. Otherwise, a pathname satisfies the filter
if and only if the value true results when the
method of
the filter is invoked on the pathname.
| ||||||||||||||||
| public static File[] | listRoots() Details
List the available filesystem roots.
A particular Java platform may support zero or more
hierarchically-organized file systems. Each file system has a
This method returns an array of The canonical pathname of a file that resides on some other machine
and is accessed via a remote-filesystem protocol such as SMB or NFS may
or may not begin with one of the roots returned by this method. If the
pathname of a remote file is syntactically indistinguishable from the
pathname of a local file then it will begin with one of the roots
returned by this method. Thus, for example, Unlike most methods in this class, this method does not throw
security exceptions. If a security manager exists and its
| ||||||||||||||||
| public boolean | mkdir() Details
Creates the directory named by this abstract pathname.
| ||||||||||||||||
| public boolean | mkdirs() Details
Creates the directory named by this abstract pathname, including any
necessary but nonexistent parent directories. Note that if this
operation fails it may have succeeded in creating some of the necessary
parent directories.
| ||||||||||||||||
| public boolean | renameTo(File dest) Details
Renames the file denoted by this abstract pathname.
Many aspects of the behavior of this method are inherently platform-dependent: The rename operation might not be able to move a file from one filesystem to another, it might not be atomic, and it might not succeed if a file with the destination abstract pathname already exists. The return value should always be checked to make sure that the rename operation was successful.
| ||||||||||||||||
| public String | toString() Details
Returns the pathname string of this abstract pathname. This is just the
string returned by the method.
| ||||||||||||||||
| public URI | toURI() Details
Constructs a file: URI that represents this abstract pathname.
The exact form of the URI is system-dependent. If it can be determined that the file denoted by this abstract pathname is a directory, then the resulting URI will end with a slash. For a given abstract pathname f, it is guaranteed that newso long as the original abstract pathname, the URI, and the new abstract pathname are all created in (possibly different invocations of) the same Java virtual machine. Due to the system-dependent nature of abstract pathnames, however, this relationship typically does not hold when a file: URI that is created in a virtual machine on one operating system is converted into an abstract pathname in a virtual machine on a different operating system.
| ||||||||||||||||
| public URL | toURL() throws MalformedURLException Details
Converts this abstract pathname into a file: URL. The
exact form of the URL is system-dependent. If it can be determined that
the file denoted by this abstract pathname is a directory, then the
resulting URL will end with a slash.
| ||||||||||||||||
| Properties | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public boolean | isAbsolute() Details
Tests whether this abstract pathname is absolute. The definition of
absolute pathname is system dependent. On UNIX systems, a pathname is
absolute if its prefix is "/". On Microsoft Windows systems, a
pathname is absolute if its prefix is a drive specifier followed by
"\\", or if its prefix is "\\\\".
| ||||||||||
| public File | getAbsoluteFile() Details
Returns the absolute form of this abstract pathname. Equivalent to
new File(this..
| ||||||||||
| public String | getAbsolutePath() Details
Returns the absolute pathname string of this abstract pathname.
If this abstract pathname is already absolute, then the pathname
string is simply returned as if by the
| ||||||||||
| public File | getCanonicalFile() throws IOException Details
Returns the canonical form of this abstract pathname. Equivalent to
new File(this..
| ||||||||||
| public String | getCanonicalPath() throws IOException Details
Returns the canonical pathname string of this abstract pathname.
A canonical pathname is both absolute and unique. The precise
definition of canonical form is system-dependent. This method first
converts this pathname to absolute form if necessary, as if by invoking the
Every pathname that denotes an existing file or directory has a unique canonical form. Every pathname that denotes a nonexistent file or directory also has a unique canonical form. The canonical form of the pathname of a nonexistent file or directory may be different from the canonical form of the same pathname after the file or directory is created. Similarly, the canonical form of the pathname of an existing file or directory may be different from the canonical form of the same pathname after the file or directory is deleted.
| ||||||||||
| public boolean | isDirectory() Details
Tests whether the file denoted by this abstract pathname is a
directory.
| ||||||||||
| public boolean | setExecutable(boolean executable, boolean ownerOnly) Details
Sets the owner's or everybody's execute permission for this abstract
pathname.
| ||||||||||
| public boolean | setExecutable(boolean executable) Details
A convenience method to set the owner's execute permission for this abstract
pathname.
An invocation of this method of the form file.setExcutable(arg) behaves in exactly the same way as the invocation
file.setExecutable(arg, true)
| ||||||||||
| public boolean | isFile() Details
Tests whether the file denoted by this abstract pathname is a normal
file. A file is normal if it is not a directory and, in
addition, satisfies other system-dependent criteria. Any non-directory
file created by a Java application is guaranteed to be a normal file.
| ||||||||||
| public long | getFreeSpace() Details
Returns the number of unallocated bytes in the partition named by this abstract path name.
The returned number of unallocated bytes is a hint, but not a guarantee, that it is possible to use most or any of these bytes. The number of unallocated bytes is most likely to be accurate immediately after this call. It is likely to be made inaccurate by any external I/O operations including those made on the system outside of this virtual machine. This method makes no guarantee that write operations to this file system will succeed.
| ||||||||||
| public boolean | isHidden() Details
Tests whether the file named by this abstract pathname is a hidden
file. The exact definition of hidden is system-dependent. On
UNIX systems, a file is considered to be hidden if its name begins with
a period character ( '.'). On Microsoft Windows systems, a file is
considered to be hidden if it has been marked as such in the filesystem.
| ||||||||||
| public boolean | setLastModified(long time) Details
Sets the last-modified time of the file or directory named by this
abstract pathname.
All platforms support file-modification times to the nearest second,
but some provide more precision. The argument will be truncated to fit
the supported precision. If the operation succeeds and no intervening
operations on the file take place, then the next invocation of the
| ||||||||||
| public String | getName() Details
Returns the name of the file or directory denoted by this abstract
pathname. This is just the last name in the pathname's name
sequence. If the pathname's name sequence is empty, then the empty
string is returned.
| ||||||||||
| public String | getParent() Details
Returns the pathname string of this abstract pathname's parent, or
null if this pathname does not name a parent directory.
The parent of an abstract pathname consists of the pathname's prefix, if any, and each name in the pathname's name sequence except for the last. If the name sequence is empty then the pathname does not name a parent directory.
| ||||||||||
| public File | getParentFile() Details
Returns the abstract pathname of this abstract pathname's parent,
or null if this pathname does not name a parent
directory.
The parent of an abstract pathname consists of the pathname's prefix, if any, and each name in the pathname's name sequence except for the last. If the name sequence is empty then the pathname does not name a parent directory.
| ||||||||||
| public String | getPath() Details
Converts this abstract pathname into a pathname string. The resulting
string uses the default name-separator character to
separate the names in the name sequence.
| ||||||||||
| public boolean | setReadable(boolean readable, boolean ownerOnly) Details
Sets the owner's or everybody's read permission for this abstract
pathname.
| ||||||||||
| public boolean | setReadable(boolean readable) Details
A convenience method to set the owner's read permission for this abstract
pathname.
An invocation of this method of the form file.setReadable(arg) behaves in exactly the same way as the invocation
file.setReadable(arg, true)
| ||||||||||
| public boolean | setReadOnly() Details
Marks the file or directory named by this abstract pathname so that
only read operations are allowed. After invoking this method the file
or directory is guaranteed not to change until it is either deleted or
marked to allow write access. Whether or not a read-only file or
directory may be deleted depends upon the underlying system.
| ||||||||||
| public long | getTotalSpace() Details
Returns the size of the partition named by this
abstract pathname.
| ||||||||||
| public long | getUsableSpace() Details
Returns the number of bytes available to this virtual machine on the
partition named by this abstract pathname. When
possible, this method checks for write permissions and other operating
system restrictions and will therefore usually provide a more accurate
estimate of how much new data can actually be written than #getFreeSpace.
The returned number of available bytes is a hint, but not a guarantee, that it is possible to use most or any of these bytes. The number of unallocated bytes is most likely to be accurate immediately after this call. It is likely to be made inaccurate by any external I/O operations including those made on the system outside of this virtual machine. This method makes no guarantee that write operations to this file system will succeed.
| ||||||||||
| public boolean | setWritable(boolean writable, boolean ownerOnly) Details
Sets the owner's or everybody's write permission for this abstract
pathname.
| ||||||||||
| public boolean | setWritable(boolean writable) Details
A convenience method to set the owner's write permission for this abstract
pathname.
An invocation of this method of the form file.setWritable(arg) behaves in exactly the same way as the invocation
file.setWritable(arg, true)
| ||||||||||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2013 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
![]() |
![]() |
|