Java Doc for FileSystem.java in  » Library » Apache-commons-vfs-20070724-src » org » apache » commons » vfs » 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 » Library » Apache commons vfs 20070724 src » org.apache.commons.vfs 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.commons.vfs.FileSystem

All known Subclasses:   org.apache.commons.vfs.provider.url.UrlFileSystem,  org.apache.commons.vfs.provider.tar.TarFileSystem,  org.apache.commons.vfs.provider.zip.ZipFileSystem,  org.apache.commons.vfs.provider.sftp.SftpFileSystem,  org.apache.commons.vfs.provider.local.LocalFileSystem,  org.apache.commons.vfs.provider.http.HttpFileSystem,  org.apache.commons.vfs.provider.AbstractFileSystem,  org.apache.commons.vfs.provider.compressed.CompressedFileFileSystem,
FileSystem
public interface FileSystem (Code)
A file system, made up of a hierarchy of files.
author:
   Adam Murdoch
version:
   $Revision: 484648 $ $Date: 2006-12-08 08:18:36 -0800 (Fri, 08 Dec 2006) $




Method Summary
 voidaddJunction(String junctionPoint, FileObject targetFile)
     Adds a junction to this file system.
 voidaddListener(FileObject file, FileListener listener)
     Adds a listener on a file in this file system.
 ObjectgetAttribute(String attrName)
     Gets the value of an attribute of the file system.

TODO - change to Map getAttributes() instead?

TODO - define the standard attribute names, and define which attrs are guaranteed to be present.
Parameters:
  attrName - The name of the attribute.

 FileSystemManagergetFileSystemManager()
    
 FileSystemOptionsgetFileSystemOptions()
    
 doublegetLastModTimeAccuracy()
     Returns the accuracy of the last modification time ms 0 perfectly accurate, >0 might be off by this value e.g.
 FileObjectgetParentLayer()
     Returns the parent layer if this is a layered file system.
 FileObjectgetRoot()
     Returns the root file of this file system.
 FileNamegetRootName()
     Returns the name of the root file of this file system.
 booleanhasCapability(Capability capability)
     Determines if this file system has a particular capability.
Parameters:
  capability - The capability to check for.
 voidremoveJunction(String junctionPoint)
     Removes a junction from this file system.
 voidremoveListener(FileObject file, FileListener listener)
     Removes a listener from a file in this file system.
 FilereplicateFile(FileObject file, FileSelector selector)
     Creates a temporary local copy of a file and its descendents.
 FileObjectresolveFile(FileName name)
     Finds a file in this file system.
Parameters:
  name - The name of the file.
 FileObjectresolveFile(String name)
     Finds a file in this file system.
Parameters:
  name - The name of the file.
 voidsetAttribute(String attrName, Object value)
     Sets the value of an attribute of the file's content.



Method Detail
addJunction
void addJunction(String junctionPoint, FileObject targetFile) throws FileSystemException(Code)
Adds a junction to this file system. A junction is a link that attaches the supplied file to a point in this file system, making it look like part of the file system.
Parameters:
  junctionPoint - The point in this file system to add the junction.
Parameters:
  targetFile - The file to link to.
throws:
  FileSystemException - If this file system does not support junctions, or the junctionpoint or target file is invalid (the file system may not supportnested junctions, for example).



addListener
void addListener(FileObject file, FileListener listener)(Code)
Adds a listener on a file in this file system.
Parameters:
  file - The file to attach the listener to.
Parameters:
  listener - The listener to add.



getAttribute
Object getAttribute(String attrName) throws FileSystemException(Code)
Gets the value of an attribute of the file system.

TODO - change to Map getAttributes() instead?

TODO - define the standard attribute names, and define which attrs are guaranteed to be present.
Parameters:
  attrName - The name of the attribute. The value of the attribute.
throws:
  org.apache.commons.vfs.FileSystemException - If the file does not exist, or is being written, or if theattribute is unknown.
See Also:   org.apache.commons.vfs.FileContent.getAttribute




getFileSystemManager
FileSystemManager getFileSystemManager()(Code)
Returns a reference to the FileSytemManager



getFileSystemOptions
FileSystemOptions getFileSystemOptions()(Code)
Returns the FileSystemOptions used to instantiate this filesystem



getLastModTimeAccuracy
double getLastModTimeAccuracy()(Code)
Returns the accuracy of the last modification time ms 0 perfectly accurate, >0 might be off by this value e.g. sftp 1000ms



getParentLayer
FileObject getParentLayer() throws FileSystemException(Code)
Returns the parent layer if this is a layered file system. The parent layer, or null if this is not a layered file system.



getRoot
FileObject getRoot() throws FileSystemException(Code)
Returns the root file of this file system.



getRootName
FileName getRootName()(Code)
Returns the name of the root file of this file system.



hasCapability
boolean hasCapability(Capability capability)(Code)
Determines if this file system has a particular capability.
Parameters:
  capability - The capability to check for. true if this filesystem has the requested capability.Note that not all files in the file system may have thecapability.



removeJunction
void removeJunction(String junctionPoint) throws FileSystemException(Code)
Removes a junction from this file system.
Parameters:
  junctionPoint - The junction to remove.
throws:
  FileSystemException - On error removing the junction.



removeListener
void removeListener(FileObject file, FileListener listener)(Code)
Removes a listener from a file in this file system.
Parameters:
  file - The file to remove the listener from.
Parameters:
  listener - The listener to remove.



replicateFile
File replicateFile(FileObject file, FileSelector selector) throws FileSystemException(Code)
Creates a temporary local copy of a file and its descendents. If this file is already a local file, a copy is not made.

Note that the local copy may include additonal files, that were not selected by the given selector.
Parameters:
  file - The file to replicate.
Parameters:
  selector - The selector to use to select the files to replicate. The local copy of this file.
throws:
  FileSystemException - If this file does not exist, or on error replicating the file.




resolveFile
FileObject resolveFile(FileName name) throws FileSystemException(Code)
Finds a file in this file system.
Parameters:
  name - The name of the file. The file. Never returns null.



resolveFile
FileObject resolveFile(String name) throws FileSystemException(Code)
Finds a file in this file system.
Parameters:
  name - The name of the file. This must be an absolute path. The file. Never returns null.



setAttribute
void setAttribute(String attrName, Object value) throws FileSystemException(Code)
Sets the value of an attribute of the file's content. Creates the file if it does not exist.
Parameters:
  attrName - The name of the attribute.
Parameters:
  value - The value of the attribute.
throws:
  FileSystemException - If the file is read-only, or is being read, or if the attributeis not supported, or on error setting the attribute.
See Also:   FileContent.setAttribute



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