org.virtualbox_4_1
Class IVFSExplorer

java.lang.Object
  extended by org.virtualbox_4_1.IUnknown
      extended by org.virtualbox_4_1.IVFSExplorer

public class IVFSExplorer
extends IUnknown

The VFSExplorer interface unifies access to different file system types. This includes local file systems as well remote file systems like S3. For a list of supported types see VFSType. An instance of this is returned by IAppliance.createVFSExplorer(String). Interface ID: {003D7F92-D38E-487F-B790-8C5E8631CB2F}


Field Summary
 
Fields inherited from class org.virtualbox_4_1.IUnknown
obj, port
 
Constructor Summary
IVFSExplorer(java.lang.String wrapped, org.virtualbox_4_1.jaxws.VboxPortType port)
           
 
Method Summary
 IProgress cd(java.lang.String aDir)
          Change the current directory level.
 IProgress cdUp()
          Go one directory upwards from the current directory level.
 void entryList(Holder<java.util.List<java.lang.String>> aNames, Holder<java.util.List<java.lang.Long>> aTypes, Holder<java.util.List<java.lang.Long>> aSizes, Holder<java.util.List<java.lang.Long>> aModes)
          Returns a list of files/directories after a call to update().
 java.util.List<java.lang.String> exists(java.util.List<java.lang.String> aNames)
          Checks if the given file list exists in the current directory level.
 java.lang.String getPath()
          Returns the current path in the virtual file system.
 VFSType getType()
          Returns the file system type which is currently in use.
static IVFSExplorer queryInterface(IUnknown obj)
           
 IProgress remove(java.util.List<java.lang.String> aNames)
          Deletes the given files in the current directory level.
 IProgress update()
          Updates the internal list of files/directories from the current directory level.
 
Methods inherited from class org.virtualbox_4_1.IUnknown
getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IVFSExplorer

public IVFSExplorer(java.lang.String wrapped,
                    org.virtualbox_4_1.jaxws.VboxPortType port)
Method Detail

getPath

public java.lang.String getPath()
Returns the current path in the virtual file system.

Returns:
String

getType

public VFSType getType()
Returns the file system type which is currently in use.

Returns:
org.virtualbox_4_1.VFSType

queryInterface

public static IVFSExplorer queryInterface(IUnknown obj)

update

public IProgress update()
Updates the internal list of files/directories from the current directory level. Use entryList(Holder,Holder,Holder,Holder) to get the full list after a call to this method.

Returns:
Progress object to track the operation completion.

cd

public IProgress cd(java.lang.String aDir)
Change the current directory level.

Parameters:
aDir - The name of the directory to go in.
Returns:
Progress object to track the operation completion.

cdUp

public IProgress cdUp()
Go one directory upwards from the current directory level.

Returns:
Progress object to track the operation completion.

entryList

public void entryList(Holder<java.util.List<java.lang.String>> aNames,
                      Holder<java.util.List<java.lang.Long>> aTypes,
                      Holder<java.util.List<java.lang.Long>> aSizes,
                      Holder<java.util.List<java.lang.Long>> aModes)
Returns a list of files/directories after a call to update(). The user is responsible for keeping this internal list up do date.

Parameters:
aNames - The list of names for the entries.
aTypes - The list of types for the entries.
aSizes - The list of sizes (in bytes) for the entries.
aModes - The list of file modes (in octal form) for the entries.

exists

public java.util.List<java.lang.String> exists(java.util.List<java.lang.String> aNames)
Checks if the given file list exists in the current directory level.

Parameters:
aNames - The names to check.
Returns:
The names which exist.

remove

public IProgress remove(java.util.List<java.lang.String> aNames)
Deletes the given files in the current directory level.

Parameters:
aNames - The names to remove.
Returns:
Progress object to track the operation completion.