summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfiguration.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/openslx/virtualization/configuration/VirtualizationConfiguration.java')
-rw-r--r--src/main/java/org/openslx/virtualization/configuration/VirtualizationConfiguration.java9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfiguration.java b/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfiguration.java
index b8e46ed..0ecd693 100644
--- a/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfiguration.java
+++ b/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfiguration.java
@@ -173,6 +173,8 @@ public abstract class VirtualizationConfiguration<T, U, W, X>
/**
* Get operating system of this VM.
+ *
+ * @return operating system of the VM.
*/
public OperatingSystem getOs()
{
@@ -181,6 +183,8 @@ public abstract class VirtualizationConfiguration<T, U, W, X>
/**
* Get all hard disks of this VM.
+ *
+ * @return list of hard disks of the VM.
*/
public List<HardDisk> getHdds()
{
@@ -189,6 +193,8 @@ public abstract class VirtualizationConfiguration<T, U, W, X>
/**
* Get display name of VM.
+ *
+ * @return display name of the VM.
*/
public String getDisplayName()
{
@@ -252,6 +258,7 @@ public abstract class VirtualizationConfiguration<T, U, W, X>
* @param osList List of supported operating systems
* @param file VM's machine description file to get the metadata instance from
* @return VmMetaData object representing the relevant parts of the given machine description
+ * @throws IOException failed to read machine description from specified file.
*/
public static VirtualizationConfiguration<?, ?, ?, ?> getInstance( List<OperatingSystem> osList, File file )
throws IOException
@@ -288,7 +295,7 @@ public abstract class VirtualizationConfiguration<T, U, W, X>
* @param vmContent VM's machine description as byte array (e.g. stored in DB)
* @param length length of the byte array given as vmContent
* @return VmMetaData object representing the relevant parts of the given machine description
- * @throws IOException
+ * @throws IOException failed to read machine description from specified byte stream.
*/
public static VirtualizationConfiguration<?, ?, ?, ?> getInstance( List<OperatingSystem> osList, byte[] vmContent,
int length )