org.virtualbox_6_1
Class IMediumFormat

java.lang.Object
  extended by org.virtualbox_6_1.IUnknown
      extended by org.virtualbox_6_1.IMediumFormat

public class IMediumFormat
extends IUnknown

The IMediumFormat interface represents a medium format. Each medium format has an associated backend which is used to handle media stored in this format. This interface provides information about the properties of the associated backend. Each medium format is identified by a string represented by thegetId()attribute. This string is used in calls likeIVirtualBox.createMedium(String,String,org.virtualbox_6_1.AccessMode,org.virtualbox_6_1.DeviceType)to specify the desired format. The list of all supported medium formats can be obtained usingISystemProperties.getMediumFormats().

See Also:
Interface ID: {11BE93C7-A862-4DC9-8C89-BF4BA74A886A}

Field Summary
 
Fields inherited from class org.virtualbox_6_1.IUnknown
obj, objMgr, port
 
Constructor Summary
IMediumFormat(java.lang.String wrapped, org.virtualbox_6_1.ObjectRefManager objMgr, org.virtualbox_6_1.jaxws.VboxPortType port)
           
 
Method Summary
 void describeFileExtensions(Holder<java.util.List<java.lang.String>> extensions, Holder<java.util.List<DeviceType>> types)
          Returns two arrays describing the supported file extensions.
 void describeProperties(Holder<java.util.List<java.lang.String>> names, Holder<java.util.List<java.lang.String>> descriptions, Holder<java.util.List<DataType>> types, Holder<java.util.List<java.lang.Long>> flags, Holder<java.util.List<java.lang.String>> defaults)
          Returns several arrays describing the properties supported by this format.
 java.util.List<MediumFormatCapabilities> getCapabilities()
          Capabilities of the format as an array of the flags.
 java.lang.String getId()
          Identifier of this format.
 java.lang.String getName()
          Human readable description of this format.
static IMediumFormat queryInterface(IUnknown obj)
           
 
Methods inherited from class org.virtualbox_6_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

IMediumFormat

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

getId

public java.lang.String getId()
Identifier of this format. The format identifier is a non- null non-empty ASCII string. Note that this string is case-insensitive. This means that, for example, all of the following strings:
"VDI"
"vdi"
"VdI"
refer to the same medium format. This string is used in methods of other interfaces where it is necessary to specify a medium format, such asIVirtualBox.createMedium(String,String,org.virtualbox_6_1.AccessMode,org.virtualbox_6_1.DeviceType).

Returns:
String

getName

public java.lang.String getName()
Human readable description of this format. Mainly for use in file open dialogs.

Returns:
String

getCapabilities

public java.util.List<MediumFormatCapabilities> getCapabilities()
Capabilities of the format as an array of the flags. For the meaning of individual capability flags seeMediumFormatCapabilities.

Returns:
List<org.virtualbox_6_1.MediumFormatCapabilities>

queryInterface

public static IMediumFormat queryInterface(IUnknown obj)

describeFileExtensions

public void describeFileExtensions(Holder<java.util.List<java.lang.String>> extensions,
                                   Holder<java.util.List<DeviceType>> types)
Returns two arrays describing the supported file extensions. The first array contains the supported extensions and the seconds one the type each extension supports. Both have the same size. Note that some backends do not work on files, so this array may be empty.

Parameters:
extensions - The array of supported extensions.
types - The array which indicates the device type for every given extension.
See Also:
getCapabilities()

describeProperties

public void describeProperties(Holder<java.util.List<java.lang.String>> names,
                               Holder<java.util.List<java.lang.String>> descriptions,
                               Holder<java.util.List<DataType>> types,
                               Holder<java.util.List<java.lang.Long>> flags,
                               Holder<java.util.List<java.lang.String>> defaults)
Returns several arrays describing the properties supported by this format. An element with the given index in each array describes one property. Thus, the number of elements in each returned array is the same and corresponds to the number of supported properties. The returned arrays are filled in only if theMediumFormatCapabilities.Propertiesflag is set. All arguments must be non- null.

Parameters:
names - Array of property names.
descriptions - Array of property descriptions.
types - Array of property types.
flags - Array of property flags.
defaults - Array of default property values.
See Also:
DataType, DataFlags