org.virtualbox_7_1
Class IDirectory

java.lang.Object
  extended by org.virtualbox_7_1.IUnknown
      extended by org.virtualbox_7_1.IDirectory
Direct Known Subclasses:
IGuestDirectory

public class IDirectory
extends IUnknown

Abstract parent interface for directories handled by VirtualBox. Interface ID: {A508E094-BF24-4ECA-80C6-467766A1E4C0}


Field Summary
 
Fields inherited from class org.virtualbox_7_1.IUnknown
obj, objMgr, port
 
Constructor Summary
IDirectory(java.lang.String wrapped, org.virtualbox_7_1.ObjectRefManager objMgr, org.virtualbox_7_1.jaxws.VboxPortType port)
           
 
Method Summary
 void close()
          Closes this directory.
 java.lang.String getDirectoryName()
          The path specified when opening the directory.
 IEventSource getEventSource()
          Event source for directory events.
 java.lang.String getFilter()
          Directory listing filter to (specified when opening the directory).
 java.lang.Long getId()
          The ID VirtualBox internally assigned to the open directory.
 DirectoryStatus getStatus()
          Current directory status.
 java.util.List<IFsObjInfo> list(java.lang.Long maxEntries)
          Lists directory entries of this directory.
static IDirectory queryInterface(IUnknown obj)
           
 IFsObjInfo read()
          Reads the next directory entry of this directory.
 void rewind()
          Rewinds the directory reading.
 
Methods inherited from class org.virtualbox_7_1.IUnknown
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IDirectory

public IDirectory(java.lang.String wrapped,
                  org.virtualbox_7_1.ObjectRefManager objMgr,
                  org.virtualbox_7_1.jaxws.VboxPortType port)
Method Detail

getDirectoryName

public java.lang.String getDirectoryName()
The path specified when opening the directory.

Returns:
String

getEventSource

public IEventSource getEventSource()
Event source for directory events.

Returns:
org.virtualbox_7_1.IEventSource

getFilter

public java.lang.String getFilter()
Directory listing filter to (specified when opening the directory).

Returns:
String

getId

public java.lang.Long getId()
The ID VirtualBox internally assigned to the open directory.

Returns:
Long

getStatus

public DirectoryStatus getStatus()
Current directory status.

Returns:
org.virtualbox_7_1.DirectoryStatus

queryInterface

public static IDirectory queryInterface(IUnknown obj)

close

public void close()
Closes this directory. After closing operations like reading the next directory entry will not be possible anymore.


list

public java.util.List<IFsObjInfo> list(java.lang.Long maxEntries)
Lists directory entries of this directory.

Expected result codes:
VBOX_E_OBJECT_NOT_FOUND - No more directory entries to read.
VBOX_E_NOT_SUPPORTED - Method not supported by installed Guest Additions.

Parameters:
maxEntries - Maximum entries to return per call. The guest might decide to return less than the given maximum, depending on the guest OS.
Returns:
Array of object information of the current directory entry read. Also seeIFsObjInfo.

read

public IFsObjInfo read()
Reads the next directory entry of this directory.

Expected result codes:
VBOX_E_OBJECT_NOT_FOUND - No more directory entries to read.

Returns:
Object information of the current directory entry read. Also seeIFsObjInfo.

rewind

public void rewind()
Rewinds the directory reading.