Java Doc for File.java in  » 6.0-JDK-Modules » j2me » java » io » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » java.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.File

File
public class File implements java.io.Serializable,Comparable(Code)
An abstract representation of file and directory pathnames.

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:

  1. An optional system-dependent prefix string, such as a disk-drive specifier, "/" for the UNIX root directory, or "\\" for a Microsoft Windows UNC pathname, and
  2. A sequence of zero or more string names.
Each name in an abstract pathname except for the last denotes a directory; the last name may denote either a directory or a file. The empty abstract pathname has no prefix and an empty name sequence.

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 File.separator and File.separatorChar 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.

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 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:

  • For UNIX platforms, the prefix of an absolute pathname is always "/". Relative pathnames have no prefix. The abstract pathname denoting the root directory has the prefix "/" and an empty name sequence.
  • For Microsoft Windows platforms, the prefix of a pathname that contains a drive specifier consists of the drive letter followed by ":" 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 the File class are immutable; that is, once created, the abstract pathname represented by a File object will never change.
version:
   1.116, 08/01/03
author:
   unascribed
since:
   JDK1.0



Field Summary
final public static  StringpathSeparator
     The system-dependent path-separator character, represented as a string for convenience.
final public static  charpathSeparatorChar
     The system-dependent path-separator character.
final public static  Stringseparator
     The system-dependent default name-separator character, represented as a string for convenience.
final public static  charseparatorChar
     The system-dependent default name-separator character.

Constructor Summary
public  File(String pathname)
     Creates a new File instance by converting the given pathname string into an abstract pathname.
public  File(String parent, String child)
     Creates a new File instance from a parent pathname string and a child pathname string.

If parent is null then the new File instance is created as if by invoking the single-argument File constructor on the given child pathname string.

Otherwise the parent pathname string is taken to denote a directory, and the child pathname string is taken to denote either a directory or a file.

public  File(File parent, String child)
     Creates a new File instance from a parent abstract pathname and a child pathname string.

If parent is null then the new File instance is created as if by invoking the single-argument File constructor on the given child pathname string.

Otherwise the parent abstract pathname is taken to denote a directory, and the child pathname string is taken to denote either a directory or a file.

public  File(URI uri)
     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. File.toURI() toURI ()).equals( f. File.getAbsoluteFile() getAbsoluteFile ())
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.

Method Summary
public  booleancanRead()
     Tests whether the application can read the file denoted by this abstract pathname.
public  booleancanWrite()
     Tests whether the application can modify to the file denoted by this abstract pathname.
public  intcompareTo(File pathname)
     Compares two abstract pathnames lexicographically.
public  intcompareTo(Object o)
     Compares this abstract pathname to another object.
public  booleancreateNewFile()
     Atomically creates a new, empty file named by this abstract pathname if and only if a file with this name does not yet exist.
public static  FilecreateTempFile(String prefix, String suffix, File directory)
    

Creates a new empty file in the specified directory, using the given prefix and suffix strings to generate its name.

public static  FilecreateTempFile(String prefix, String suffix)
     Creates an empty file in the default temporary-file directory, using the given prefix and suffix to generate its name.
public  booleandelete()
     Deletes the file or directory denoted by this abstract pathname.
public  voiddeleteOnExit()
     Requests that the file or directory denoted by this abstract pathname be deleted when the virtual machine terminates.
public  booleanequals(Object obj)
     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.
public  booleanexists()
     Tests whether the file or directory denoted by this abstract pathname exists.
public  FilegetAbsoluteFile()
     Returns the absolute form of this abstract pathname.
public  StringgetAbsolutePath()
     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 File.getPath method.

public  FilegetCanonicalFile()
     Returns the canonical form of this abstract pathname.
public  StringgetCanonicalPath()
     Returns the canonical pathname string of this abstract pathname.

A canonical pathname is both absolute and unique.

public  StringgetName()
     Returns the name of the file or directory denoted by this abstract pathname.
public  StringgetParent()
     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.

public  FilegetParentFile()
     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.

public  StringgetPath()
     Converts this abstract pathname into a pathname string.
 intgetPrefixLength()
     Returns the length of this abstract pathname's prefix.
public  inthashCode()
     Computes a hash code for this abstract pathname.
public  booleanisAbsolute()
     Tests whether this abstract pathname is absolute.
public  booleanisDirectory()
     Tests whether the file denoted by this abstract pathname is a directory.
public  booleanisFile()
     Tests whether the file denoted by this abstract pathname is a normal file.
public  booleanisHidden()
     Tests whether the file named by this abstract pathname is a hidden file.
public  longlastModified()
     Returns the time that the file denoted by this abstract pathname was last modified.
public  longlength()
     Returns the length of the file denoted by this abstract pathname.
public  String[]list()
     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 null.

public  String[]list(FilenameFilter filter)
     Returns an array of strings naming the files and directories in the directory denoted by this abstract pathname that satisfy the specified filter.
public  File[]listFiles()
     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 null.

public  File[]listFiles(FilenameFilter filter)
     Returns an array of abstract pathnames denoting the files and directories in the directory denoted by this abstract pathname that satisfy the specified filter.
public  File[]listFiles(FileFilter filter)
     Returns an array of abstract pathnames denoting the files and directories in the directory denoted by this abstract pathname that satisfy the specified filter.
public static  File[]listRoots()
     List the available filesystem roots.

A particular Java platform may support zero or more hierarchically-organized file systems.

public  booleanmkdir()
     Creates the directory named by this abstract pathname.
public  booleanmkdirs()
     Creates the directory named by this abstract pathname, including any necessary but nonexistent parent directories.
public  booleanrenameTo(File dest)
     Renames the file denoted by this abstract pathname.

Whether or not this method can move a file from one filesystem to another is platform-dependent.

public  booleansetLastModified(long time)
     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.

public  booleansetReadOnly()
     Marks the file or directory named by this abstract pathname so that only read operations are allowed.
public  StringtoString()
     Returns the pathname string of this abstract pathname.
public  URItoURI()
     Constructs a file: URI that represents this abstract pathname.

The exact form of the URI is system-dependent.

public  URLtoURL()
     Converts this abstract pathname into a file: URL.

Field Detail
pathSeparator
final public static String pathSeparator(Code)
The system-dependent path-separator character, represented as a string for convenience. This string contains a single character, namely File.pathSeparatorChar .



pathSeparatorChar
final public static char pathSeparatorChar(Code)
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 ';'.
See Also:   java.lang.System.getProperty(java.lang.String)



separator
final public static String separator(Code)
The system-dependent default name-separator character, represented as a string for convenience. This string contains a single character, namely File.separatorChar .



separatorChar
final public static char separatorChar(Code)
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 '\'.
See Also:   java.lang.System.getProperty(java.lang.String)




Constructor Detail
File
public File(String pathname)(Code)
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.
Parameters:
  pathname - A pathname string
throws:
  NullPointerException - If the pathname argument is null



File
public File(String parent, String child)(Code)
Creates a new File instance from a parent pathname string and a child pathname string.

If parent is null then the new File instance is created as if by invoking the single-argument File constructor on the given child pathname string.

Otherwise the parent pathname string is taken to denote a directory, and the child pathname string is taken to denote either a directory or a file. If the child pathname string is absolute then it is converted into a relative pathname in a system-dependent way. If parent is the empty string then the new File instance is created by converting child into an abstract pathname and resolving the result against a system-dependent default directory. Otherwise each pathname string is converted into an abstract pathname and the child abstract pathname is resolved against the parent.
Parameters:
  parent - The parent pathname string
Parameters:
  child - The child pathname string
throws:
  NullPointerException - If child is null




File
public File(File parent, String child)(Code)
Creates a new File instance from a parent abstract pathname and a child pathname string.

If parent is null then the new File instance is created as if by invoking the single-argument File constructor on the given child pathname string.

Otherwise the parent abstract pathname is taken to denote a directory, and the child pathname string is taken to denote either a directory or a file. If the child pathname string is absolute then it is converted into a relative pathname in a system-dependent way. If parent is the empty abstract pathname then the new File instance is created by converting child into an abstract pathname and resolving the result against a system-dependent default directory. Otherwise each pathname string is converted into an abstract pathname and the child abstract pathname is resolved against the parent.
Parameters:
  parent - The parent abstract pathname
Parameters:
  child - The child pathname string
throws:
  NullPointerException - If child is null




File
public File(URI uri)(Code)
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. File.toURI() toURI ()).equals( f. File.getAbsoluteFile() getAbsoluteFile ())
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.
Parameters:
  uri - An absolute, hierarchical URI with a scheme equal to"file", a non-empty path component, and undefinedauthority, query, and fragment components
throws:
  NullPointerException - If uri is null
throws:
  IllegalArgumentException - If the preconditions on the parameter do not hold
See Also:   File.toURI()
See Also:   java.net.URI
since:
   1.4




Method Detail
canRead
public boolean canRead()(Code)
Tests whether the application can read the file denoted by this abstract pathname. true if and only if the file specified by thisabstract pathname exists and can be read by theapplication; false otherwise
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkRead(java.lang.String)method denies read access to the file



canWrite
public boolean canWrite()(Code)
Tests whether the application can modify to the file denoted by this abstract pathname. true if and only if the file system actuallycontains a file denoted by this abstract pathname andthe application is allowed to write to the file;false otherwise.
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkWrite(java.lang.String)method denies write access to the file



compareTo
public int compareTo(File pathname)(Code)
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.
Parameters:
  pathname - The abstract pathname to be compared to this abstractpathname Zero if the argument is equal to this abstract pathname, avalue less than zero if this abstract pathname islexicographically less than the argument, or a value greaterthan zero if this abstract pathname is lexicographicallygreater than the argument
since:
   1.2



compareTo
public int compareTo(Object o)(Code)
Compares this abstract pathname to another object. If the other object is an abstract pathname, then this function behaves like File.compareTo(File) . Otherwise, it throws a ClassCastException, since abstract pathnames can only be compared to abstract pathnames.
Parameters:
  o - The Object to be compared to this abstractpathname If the argument is an abstract pathname, returns zeroif the argument is equal to this abstract pathname, a valueless than zero if this abstract pathname is lexicographicallyless than the argument, or a value greater than zero if thisabstract pathname is lexicographically greater than theargument ClassCastException if the argument is not anabstract pathname
See Also:   java.lang.Comparable
since:
   1.2



createNewFile
public boolean createNewFile() throws IOException(Code)
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. true if the named file does not exist and wassuccessfully created; false if the named filealready exists
throws:
  IOException - If an I/O error occurred
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkWrite(java.lang.String)method denies write access to the file
since:
   1.2




createTempFile
public static File createTempFile(String prefix, String suffix, File directory) throws IOException(Code)

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:

  1. The file denoted by the returned abstract pathname did not exist before this method was invoked, and
  2. Neither this method nor any of its variants will return the same abstract pathname again in the current invocation of the virtual machine.
This method provides only part of a temporary-file facility. To arrange for a file created by this method to be deleted automatically, use the File.deleteOnExit method.

The prefix argument must be at least three characters long. It is recommended that the prefix be a short, meaningful string such as "hjb" or "mail". The suffix argument may be null, in which case the suffix ".tmp" will be used.

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 ('.') then the period and the first three characters following it will always be preserved. Once these adjustments have been made the name of the new file will be generated by concatenating the prefix, five or more internally-generated characters, and the suffix.

If the directory argument is null then the system-dependent default temporary-file directory will be used. The default temporary-file directory is specified by the system property java.io.tmpdir. On UNIX systems the default value of this property is typically "/tmp" or "/var/tmp"; on Microsoft Windows systems it is typically "c:\\temp". A different value may be given to this system property when the Java virtual machine is invoked, but programmatic changes to this property are not guaranteed to have any effect upon the the temporary directory used by this method.
Parameters:
  prefix - The prefix string to be used in generating the file'sname; must be at least three characters long
Parameters:
  suffix - The suffix string to be used in generating the file'sname; may be null, in which case thesuffix ".tmp" will be used
Parameters:
  directory - The directory in which the file is to be created, ornull if the default temporary-filedirectory is to be used An abstract pathname denoting a newly-created empty file
throws:
  IllegalArgumentException - If the prefix argument contains fewer than threecharacters
throws:
  IOException - If a file could not be created
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkWrite(java.lang.String)method does not allow a file to be created
since:
   1.2




createTempFile
public static File createTempFile(String prefix, String suffix) throws IOException(Code)
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 File.createTempFile(java.lang.String,java.lang.String,java.io.File)createTempFile(prefix, suffix, null) .
Parameters:
  prefix - The prefix string to be used in generating the file'sname; must be at least three characters long
Parameters:
  suffix - The suffix string to be used in generating the file'sname; may be null, in which case thesuffix ".tmp" will be used An abstract pathname denoting a newly-created empty file
throws:
  IllegalArgumentException - If the prefix argument contains fewer than threecharacters
throws:
  IOException - If a file could not be created
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkWrite(java.lang.String)method does not allow a file to be created
since:
   1.2



delete
public boolean delete()(Code)
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. true if and only if the file or directory issuccessfully deleted; false otherwise
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkDelete method deniesdelete access to the file



deleteOnExit
public void deleteOnExit()(Code)
Requests that the file or directory denoted by this abstract pathname be deleted when the virtual machine terminates. 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.
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkDelete method deniesdelete access to the file
See Also:   File.delete
since:
   1.2




equals
public boolean equals(Object obj)(Code)
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.
Parameters:
  obj - The object to be compared with this abstract pathname true if and only if the objects are the same;false otherwise



exists
public boolean exists()(Code)
Tests whether the file or directory denoted by this abstract pathname exists. true if and only if the file or directory denotedby this abstract pathname exists; false otherwise
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkRead(java.lang.String)method denies read access to the file or directory



getAbsoluteFile
public File getAbsoluteFile()(Code)
Returns the absolute form of this abstract pathname. Equivalent to new File(this. File.getAbsolutePath ()). The absolute abstract pathname denoting the same file ordirectory as this abstract pathname
throws:
  SecurityException - If a required system property value cannot be accessed.
since:
   1.2



getAbsolutePath
public String getAbsolutePath()(Code)
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 File.getPath method. If this abstract pathname is the empty abstract pathname then the pathname string of the current user directory, which is named by the system property user.dir, is returned. Otherwise this pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory. The absolute pathname string denoting the same file ordirectory as this abstract pathname
throws:
  SecurityException - If a required system property value cannot be accessed.
See Also:   java.io.File.isAbsolute




getCanonicalFile
public File getCanonicalFile() throws IOException(Code)
Returns the canonical form of this abstract pathname. Equivalent to new File(this. File.getCanonicalPath ()). The canonical pathname string denoting the same file ordirectory as this abstract pathname
throws:
  IOException - If an I/O error occurs, which is possible because theconstruction of the canonical pathname may requirefilesystem queries
throws:
  SecurityException - If a required system property value cannot be accessed.
since:
   1.2



getCanonicalPath
public String getCanonicalPath() throws IOException(Code)
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 File.getAbsolutePath method, and then maps it to its unique form in a system-dependent way. This typically involves removing redundant names such as "." and ".." from the pathname, resolving symbolic links (on UNIX platforms), and converting drive letters to a standard case (on Microsoft Windows platforms).

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. The canonical pathname string denoting the same file ordirectory as this abstract pathname
throws:
  IOException - If an I/O error occurs, which is possible because theconstruction of the canonical pathname may requirefilesystem queries
throws:
  SecurityException - If a required system property value cannot be accessed.
since:
   JDK1.1




getName
public String getName()(Code)
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. The name of the file or directory denoted by this abstractpathname, or the empty string if this pathname's name sequenceis empty



getParent
public String getParent()(Code)
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. The pathname string of the parent directory named by thisabstract pathname, or null if this pathnamedoes not name a parent




getParentFile
public File getParentFile()(Code)
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. The abstract pathname of the parent directory named by thisabstract pathname, or null if this pathnamedoes not name a parent
since:
   1.2




getPath
public String getPath()(Code)
Converts this abstract pathname into a pathname string. The resulting string uses the File.separator default name-separator character to separate the names in the name sequence. The string form of this abstract pathname



getPrefixLength
int getPrefixLength()(Code)
Returns the length of this abstract pathname's prefix. For use by FileSystem classes.



hashCode
public int hashCode()(Code)
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 its pathname string and the decimal value 1234321. On Microsoft Windows systems, the hash code is equal to the exclusive or of its pathname string, convered to lower case, and the decimal value 1234321. A hash code for this abstract pathname



isAbsolute
public boolean isAbsolute()(Code)
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 "\\". true if this abstract pathname is absolute,false otherwise



isDirectory
public boolean isDirectory()(Code)
Tests whether the file denoted by this abstract pathname is a directory. true if and only if the file denoted by thisabstract pathname exists and is a directory;false otherwise
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkRead(java.lang.String)method denies read access to the file



isFile
public boolean isFile()(Code)
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. true if and only if the file denoted by thisabstract pathname exists and is a normal file;false otherwise
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkRead(java.lang.String)method denies read access to the file



isHidden
public boolean isHidden()(Code)
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. true if and only if the file denoted by thisabstract pathname is hidden according to the conventions of theunderlying platform
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkRead(java.lang.String)method denies read access to the file
since:
   1.2



lastModified
public long lastModified()(Code)
Returns the time that the file denoted by this abstract pathname was last modified. A long value representing the time the file waslast modified, measured in milliseconds since the epoch(00:00:00 GMT, January 1, 1970), or 0L if thefile does not exist or if an I/O error occurs
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkRead(java.lang.String)method denies read access to the file



length
public long length()(Code)
Returns the length of the file denoted by this abstract pathname. The return value is unspecified if this pathname denotes a directory. The length, in bytes, of the file denoted by this abstractpathname, or 0L if the file does not exist
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkRead(java.lang.String)method denies read access to the file



list
public String[] list()(Code)
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 null. Otherwise an array of strings is returned, one for each file or directory in the directory. Names denoting the directory itself and the directory's parent directory are not included in the result. Each string is a file name rather than a complete path.

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. An array of strings naming the files and directories in thedirectory denoted by this abstract pathname. The array will beempty if the directory is empty. Returns null ifthis abstract pathname does not denote a directory, or if anI/O error occurs.
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkRead(java.lang.String)method denies read access to the directory




list
public String[] list(FilenameFilter filter)(Code)
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 File.list() 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 FilenameFilter.accept method of the filter is invoked on this abstract pathname and the name of a file or directory in the directory that it denotes.
Parameters:
  filter - A filename filter An array of strings naming the files and directories in thedirectory denoted by this abstract pathname that were acceptedby the given filter. The array will be empty ifthe directory is empty or if no names were accepted by thefilter. Returns null if this abstract pathnamedoes not denote a directory, or if an I/O error occurs.
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkRead(java.lang.String)method denies read access to the directory



listFiles
public File[] listFiles()(Code)
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 null. Otherwise an array of File objects is returned, one for each file or directory in the directory. Pathnames denoting the directory itself and the directory's parent directory are not included in the result. Each resulting abstract pathname is constructed from this abstract pathname using the File.File(java.io.File,java.lang.String)File(File, String) constructor. Therefore if this pathname is absolute then each resulting pathname is absolute; if this pathname is relative then each resulting pathname will be relative to the same directory.

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. An array of abstract pathnames denoting the files anddirectories in the directory denoted by this abstractpathname. The array will be empty if the directory isempty. Returns null if this abstract pathnamedoes not denote a directory, or if an I/O error occurs.
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkRead(java.lang.String)method denies read access to the directory
since:
   1.2




listFiles
public File[] listFiles(FilenameFilter filter)(Code)
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 File.listFiles() 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 FilenameFilter.accept method of the filter is invoked on this abstract pathname and the name of a file or directory in the directory that it denotes.
Parameters:
  filter - A filename filter An array of abstract pathnames denoting the files anddirectories in the directory denoted by this abstractpathname. The array will be empty if the directory isempty. Returns null if this abstract pathnamedoes not denote a directory, or if an I/O error occurs.
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkRead(java.lang.String)method denies read access to the directory
since:
   1.2



listFiles
public File[] listFiles(FileFilter filter)(Code)
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 File.listFiles() 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 FileFilter.accept(java.io.File) method of the filter is invoked on the pathname.
Parameters:
  filter - A file filter An array of abstract pathnames denoting the files anddirectories in the directory denoted by this abstractpathname. The array will be empty if the directory isempty. Returns null if this abstract pathnamedoes not denote a directory, or if an I/O error occurs.
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkRead(java.lang.String)method denies read access to the directory
since:
   1.2



listRoots
public static File[] listRoots()(Code)
List the available filesystem roots.

A particular Java platform may support zero or more hierarchically-organized file systems. Each file system has a root directory from which all other files in that file system can be reached. Windows platforms, for example, have a root directory for each active drive; UNIX platforms have a single root directory, namely "/". The set of available filesystem roots is affected by various system-level operations such the insertion or ejection of removable media and the disconnecting or unmounting of physical or virtual disk drives.

This method returns an array of File objects that denote the root directories of the available filesystem roots. It is guaranteed that the canonical pathname of any file physically present on the local machine will begin with one of the roots returned by this method.

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, File objects denoting the root directories of the mapped network drives of a Windows platform will be returned by this method, while File objects containing UNC pathnames will not be returned by this method.

Unlike most methods in this class, this method does not throw security exceptions. If a security manager exists and its java.lang.SecurityManager.checkRead(java.lang.String) method denies read access to a particular root directory, then that directory will not appear in the result. An array of File objects denoting the availablefilesystem roots, or null if the set of rootscould not be determined. The array will be empty if there areno filesystem roots.
since:
   1.2




mkdir
public boolean mkdir()(Code)
Creates the directory named by this abstract pathname. true if and only if the directory wascreated; false otherwise
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkWrite(java.lang.String)method does not permit the named directory to be created



mkdirs
public boolean mkdirs()(Code)
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. true if and only if the directory was created,along with all necessary parent directories; falseotherwise
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkWrite(java.lang.String)method does not permit the named directory and all necessaryparent directories and to be created



renameTo
public boolean renameTo(File dest)(Code)
Renames the file denoted by this abstract pathname.

Whether or not this method can move a file from one filesystem to another is platform-dependent. The return value should always be checked to make sure that the rename operation was successful.
Parameters:
  dest - The new abstract pathname for the named file true if and only if the renaming succeeded;false otherwise
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkWrite(java.lang.String)method denies write access to either the old or new pathnames
throws:
  NullPointerException - If parameter dest is null




setLastModified
public boolean setLastModified(long time)(Code)
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 File.lastModified method will return the (possibly truncated) time argument that was passed to this method.
Parameters:
  time - The new last-modified time, measured in milliseconds sincethe epoch (00:00:00 GMT, January 1, 1970) true if and only if the operation succeeded;false otherwise
throws:
  IllegalArgumentException - If the argument is negative
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkWrite(java.lang.String)method denies write access to the named file
since:
   1.2




setReadOnly
public boolean setReadOnly()(Code)
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. true if and only if the operation succeeded;false otherwise
throws:
  SecurityException - If a security manager exists and its java.lang.SecurityManager.checkWrite(java.lang.String)method denies write access to the named file
since:
   1.2



toString
public String toString()(Code)
Returns the pathname string of this abstract pathname. This is just the string returned by the File.getPath method. The string form of this abstract pathname



toURI
public URI toURI()(Code)
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

new File.File(java.net.URI) File ( f.toURI()).equals( f. File.getAbsoluteFile() getAbsoluteFile ())
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. 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. An absolute, hierarchical URI with a scheme equal to"file", a path representing this abstract pathname,and undefined authority, query, and fragment components
See Also:   File.File(java.net.URI)
See Also:   java.net.URI
See Also:   java.net.URI.toURL
since:
   1.4



toURL
public URL toURL() throws MalformedURLException(Code)
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.

Usage note: This method does not automatically escape characters that are illegal in URLs. It is recommended that new code convert an abstract pathname into a URL by first converting it into a URI, via the File.toURI() toURI method, and then converting the URI into a URL via the java.net.URI.toURL URI.toURL method. A URL object representing the equivalent file URL
throws:
  MalformedURLException - If the path cannot be parsed as a URL
See Also:   File.toURI()
See Also:   java.net.URI
See Also:   java.net.URI.toURL
See Also:   java.net.URL
since:
   1.2




Methods inherited from java.lang.Object
public boolean equals(Object obj)(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.