VFSUtils (vfsjfilechooser2 0.2.10 API)

java.lang.Object
- com.googlecode.vfsjfilechooser2.utils.VFSUtils

```
public final class VFSUtils
extends Object
```
A helper class to deal with commons-vfs file abstractions

Version:

0.0.5

Author:

Yves Zoundi , Jojada Tirtowidjojo , Stephan Schuster , FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`ONE_GB` The number of bytes in a gigabyte.
`static long`	`ONE_KB` The number of bytes in a kilobyte.
`static long`	`ONE_MB` The number of bytes in a megabyte.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`byteCountToDisplaySize(long size)` Returns a human-readable version of the file size, where the input represents a specific number of bytes.
`static boolean`	`canWrite(org.apache.commons.vfs2.FileObject fileObject)` Tells whether a file is writable
`static org.apache.commons.vfs2.FileObject`	`createFileObject(String filePath)` Returns a file representation
`static org.apache.commons.vfs2.FileObject`	`createFileSystemRoot(org.apache.commons.vfs2.FileObject fileObject)` Returns the root filesystem of a given file
`static boolean`	`exists(org.apache.commons.vfs2.FileObject fileObject)` Tells whether a file exists
`static org.apache.commons.vfs2.FileObject[]`	`getFiles(org.apache.commons.vfs2.FileObject folder)` Returns all the files of a folder
`static org.apache.commons.vfs2.FileObject[]`	`getFiles(org.apache.commons.vfs2.FileObject folder, boolean useFileHiding)` Return a folder's files
`static org.apache.commons.vfs2.FileSystemManager`	`getFileSystemManager()` Returns the global filesystem manager
`static String`	`getFriendlyName(String fileName)` Remove user credentials information
`static String`	`getFriendlyName(String fileName, boolean excludeLocalFilePrefix)`
`static InputStream`	`getInputStream(org.apache.commons.vfs2.FileObject fileObject)` Returns a buffered input stream from a file
`static OutputStream`	`getOutputStream(org.apache.commons.vfs2.FileObject fileObject)` Returns a buffered output stream from a file
`static org.apache.commons.vfs2.FileObject`	`getParentDirectory(org.apache.commons.vfs2.FileObject fileObject)` Returns the parent directory of a file object
`static org.apache.commons.vfs2.FileObject`	`getRootFileSystem(org.apache.commons.vfs2.FileObject fileObject)` Returns the root file system of a file representation
`static boolean`	`isDirectory(org.apache.commons.vfs2.FileObject fileObject)` Returns whether a file object is a directory
`static boolean`	`isFileSystemRoot(org.apache.commons.vfs2.FileObject folder)` Tells whether a folder is the root filesystem
`static boolean`	`isHiddenFile(org.apache.commons.vfs2.FileObject fileObject)` Tells whether a file is hidden
`static boolean`	`isParent(org.apache.commons.vfs2.FileObject folder, org.apache.commons.vfs2.FileObject file)` Returns whether a folder contains a given file
`static boolean`	`isRoot(org.apache.commons.vfs2.FileObject fileObject)` Tells whether a file is the root file system
`static org.apache.commons.vfs2.FileObject`	`resolveFileObject(org.apache.commons.vfs2.FileObject folder, String filename)` Returns a file representation
`static org.apache.commons.vfs2.FileObject`	`resolveFileObject(String filePath)` Returns a file representation
`static org.apache.commons.vfs2.FileObject`	`resolveFileObject(String filePath, org.apache.commons.vfs2.FileSystemOptions options)` Returns a file representation
`static void`	`setFileSystemManager(org.apache.commons.vfs2.FileSystemManager aFileSystemManager)` Sets the global filesystem manager
`static void`	`setFileSystemOptions(org.apache.commons.vfs2.FileSystemOptions fileSystemOptions)`
`static org.apache.commons.vfs2.FileObject`	`toFileObject(File file)` Returns a file representation of a local file

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ONE_KB
```
public static final long ONE_KB
```
    The number of bytes in a kilobyte.
    
    See Also:
    
    Constant Field Values
  - ONE_MB
```
public static final long ONE_MB
```
    The number of bytes in a megabyte.
    
    See Also:
    
    Constant Field Values
  - ONE_GB
```
public static final long ONE_GB
```
    The number of bytes in a gigabyte.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setFileSystemOptions
```
public static void setFileSystemOptions(org.apache.commons.vfs2.FileSystemOptions fileSystemOptions)
```
  - getFileSystemManager
```
public static org.apache.commons.vfs2.FileSystemManager getFileSystemManager()
```
    Returns the global filesystem manager
    
    Returns:
    
    the global filesystem manager
  - setFileSystemManager
```
public static void setFileSystemManager(org.apache.commons.vfs2.FileSystemManager aFileSystemManager)
```
    Sets the global filesystem manager
    
    Parameters:
    
    aFileSystemManager - the global filesystem manager
  - byteCountToDisplaySize
```
public static String byteCountToDisplaySize(long size)
```
    Returns a human-readable version of the file size, where the input represents a specific number of bytes.
    
    Parameters:
    
    size - the number of bytes
    
    Returns:
    
    a human-readable display value (includes units)
  - getInputStream
```
public static InputStream getInputStream(org.apache.commons.vfs2.FileObject fileObject)
                                  throws org.apache.commons.vfs2.FileSystemException
```
    Returns a buffered input stream from a file
    
    Parameters:
    
    fileObject - A file object
    
    Returns:
    
    an InputStream from the file object
    
    Throws:
    
    org.apache.commons.vfs2.FileSystemException - An exception while getting the file
  - getOutputStream
```
public static OutputStream getOutputStream(org.apache.commons.vfs2.FileObject fileObject)
                                    throws org.apache.commons.vfs2.FileSystemException
```
    Returns a buffered output stream from a file
    
    Parameters:
    
    fileObject - A file object
    
    Returns:
    
    an OutputStream from the file object
    
    Throws:
    
    org.apache.commons.vfs2.FileSystemException - An exception while getting the file
  - canWrite
```
public static boolean canWrite(org.apache.commons.vfs2.FileObject fileObject)
```
    Tells whether a file is writable
    
    Parameters:
    
    fileObject -
    
    Returns:
    
    whether a file is writable
  - createFileObject
```
public static org.apache.commons.vfs2.FileObject createFileObject(String filePath)
```
    Returns a file representation
    
    Parameters:
    
    filePath - The file path
    
    Returns:
    
    a file representation
  - getFriendlyName
```
public static final String getFriendlyName(String fileName)
```
    Remove user credentials information
    
    Parameters:
    
    fileName - The file name
    
    Returns:
    
    The "safe" display name without username and password information
  - getFriendlyName
```
public static final String getFriendlyName(String fileName,
                                           boolean excludeLocalFilePrefix)
```
  - createFileSystemRoot
```
public static org.apache.commons.vfs2.FileObject createFileSystemRoot(org.apache.commons.vfs2.FileObject fileObject)
```
    Returns the root filesystem of a given file
    
    Parameters:
    
    fileObject - A file
    
    Returns:
    
    the root filesystem of a given file
  - getFiles
```
public static org.apache.commons.vfs2.FileObject[] getFiles(org.apache.commons.vfs2.FileObject folder)
```
    Returns all the files of a folder
    
    Parameters:
    
    folder - A folder
    
    Returns:
    
    the files of a folder
  - getFiles
```
public static org.apache.commons.vfs2.FileObject[] getFiles(org.apache.commons.vfs2.FileObject folder,
                                                            boolean useFileHiding)
```
    Return a folder's files
    
    Parameters:
    
    folder - A folder abstraction
    
    useFileHiding - flag to include hidden files
    
    Returns:
    
    a folder's files
  - getRootFileSystem
```
public static org.apache.commons.vfs2.FileObject getRootFileSystem(org.apache.commons.vfs2.FileObject fileObject)
```
    Returns the root file system of a file representation
    
    Parameters:
    
    fileObject - A file abstraction
    
    Returns:
    
    the root file system of a file representation
  - isHiddenFile
```
public static boolean isHiddenFile(org.apache.commons.vfs2.FileObject fileObject)
```
    Tells whether a file is hidden
    
    Parameters:
    
    fileObject - a file representation
    
    Returns:
    
    whether a file is hidden
  - isRoot
```
public static boolean isRoot(org.apache.commons.vfs2.FileObject fileObject)
```
    Tells whether a file is the root file system
    
    Parameters:
    
    fileObject - A file representation
    
    Returns:
    
    whether a file is the root file system
  - toFileObject
```
public static org.apache.commons.vfs2.FileObject toFileObject(File file)
```
    Returns a file representation of a local file
    
    Parameters:
    
    file - a local file
    
    Returns:
    
    a file representation of a local file
  - getParentDirectory
```
public static org.apache.commons.vfs2.FileObject getParentDirectory(org.apache.commons.vfs2.FileObject fileObject)
```
    Returns the parent directory of a file object
    
    Parameters:
    
    fileObject - A file representation
    
    Returns:
    
    the parent directory of a file object
  - resolveFileObject
```
public static org.apache.commons.vfs2.FileObject resolveFileObject(String filePath)
```
    Returns a file representation
    
    Parameters:
    
    filePath - The file path
    
    Returns:
    
    a file representation
  - resolveFileObject
```
public static org.apache.commons.vfs2.FileObject resolveFileObject(String filePath,
                                                                   org.apache.commons.vfs2.FileSystemOptions options)
```
    Returns a file representation
    
    Parameters:
    
    filePath - The file path
    
    options - The filesystem options
    
    Returns:
    
    a file representation
  - resolveFileObject
```
public static org.apache.commons.vfs2.FileObject resolveFileObject(org.apache.commons.vfs2.FileObject folder,
                                                                   String filename)
```
    Returns a file representation
    
    Parameters:
    
    folder - A folder
    
    filename - A filename
    
    Returns:
    
    a file contained in a given folder
  - exists
```
public static boolean exists(org.apache.commons.vfs2.FileObject fileObject)
```
    Tells whether a file exists
    
    Parameters:
    
    fileObject - A file representation
    
    Returns:
    
    whether a file exists
  - isDirectory
```
public static boolean isDirectory(org.apache.commons.vfs2.FileObject fileObject)
```
    Returns whether a file object is a directory
    
    Parameters:
    
    fileObject - A file object representation
    
    Returns:
    
    whether a file object is a directory
  - isFileSystemRoot
```
public static boolean isFileSystemRoot(org.apache.commons.vfs2.FileObject folder)
```
    Tells whether a folder is the root filesystem
    
    Parameters:
    
    folder - A folder
    
    Returns:
    
    whether a folder is the root filesystem
  - isParent
```
public static boolean isParent(org.apache.commons.vfs2.FileObject folder,
                               org.apache.commons.vfs2.FileObject file)
```
    Returns whether a folder contains a given file
    
    Parameters:
    
    folder - A folder
    
    file - A file
    
    Returns:
    
    whether a folder contains a given file

Class VFSUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ONE_KB

ONE_MB

ONE_GB

Method Detail

setFileSystemOptions

getFileSystemManager

setFileSystemManager

byteCountToDisplaySize

getInputStream

getOutputStream

canWrite

createFileObject

getFriendlyName

getFriendlyName

createFileSystemRoot

getFiles

getFiles

getRootFileSystem

isHiddenFile

isRoot

toFileObject

getParentDirectory

resolveFileObject

resolveFileObject

resolveFileObject

exists

isDirectory

isFileSystemRoot

isParent