From 230e75e440428c4a6309213777f87f7e3e07760f Mon Sep 17 00:00:00 2001
From: Manuel Bentele
Date: Tue, 20 Apr 2021 13:56:25 +0200
Subject: Encapsulate transformation logic for virtualization configurations

---
 ...onfigurationDataDozModClientToDozModServer.java |  8 ++++
 ...onfigurationDataDozModServerToDozModClient.java | 49 ++++++++++++++++++++++
 ...igurationDataDozModServerToStatelessClient.java | 30 +++++++++++++
 3 files changed, 87 insertions(+)
 create mode 100644 src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModClientToDozModServer.java
 create mode 100644 src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java
 create mode 100644 src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToStatelessClient.java

(limited to 'src/main/java/org/openslx/virtualization/configuration/data')

diff --git a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModClientToDozModServer.java b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModClientToDozModServer.java
new file mode 100644
index 0000000..dda62aa
--- /dev/null
+++ b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModClientToDozModServer.java
@@ -0,0 +1,8 @@
+package org.openslx.virtualization.configuration.data;
+
+public class ConfigurationDataDozModClientToDozModServer
+{
+	public ConfigurationDataDozModClientToDozModServer()
+	{
+	}
+}
diff --git a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java
new file mode 100644
index 0000000..c1ae37a
--- /dev/null
+++ b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java
@@ -0,0 +1,49 @@
+package org.openslx.virtualization.configuration.data;
+
+import java.io.File;
+
+import org.openslx.bwlp.thrift.iface.OperatingSystem;
+
+public class ConfigurationDataDozModServerToDozModClient
+{
+	private final String displayName;
+	private final File diskImage;
+	private final OperatingSystem guestOs;
+	private final String virtualizerId;
+	private final int totalMemory;
+
+	public ConfigurationDataDozModServerToDozModClient( String displayName, File diskImage, OperatingSystem guestOs,
+			String virtualizerId, int totalMemory )
+	{
+		this.displayName = displayName;
+		this.diskImage = diskImage;
+		this.guestOs = guestOs;
+		this.virtualizerId = virtualizerId;
+		this.totalMemory = totalMemory;
+	}
+
+	public String getDisplayName()
+	{
+		return this.displayName;
+	}
+
+	public File getDiskImage()
+	{
+		return this.diskImage;
+	}
+
+	public OperatingSystem getGuestOs()
+	{
+		return this.guestOs;
+	}
+
+	public String getVirtualizerId()
+	{
+		return this.virtualizerId;
+	}
+
+	public int getTotalMemory()
+	{
+		return this.totalMemory;
+	}
+}
diff --git a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToStatelessClient.java b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToStatelessClient.java
new file mode 100644
index 0000000..f5d9a31
--- /dev/null
+++ b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToStatelessClient.java
@@ -0,0 +1,30 @@
+package org.openslx.virtualization.configuration.data;
+
+public class ConfigurationDataDozModServerToStatelessClient
+{
+	private final String displayName;
+	private final String osId;
+	private final boolean hasUsbAccess;
+
+	public ConfigurationDataDozModServerToStatelessClient( String displayName, String osId, boolean hasUsbAccess )
+	{
+		this.displayName = displayName;
+		this.osId = osId;
+		this.hasUsbAccess = hasUsbAccess;
+	}
+
+	public String getDisplayName()
+	{
+		return this.displayName;
+	}
+
+	public String getOsId()
+	{
+		return this.osId;
+	}
+
+	public boolean hasUsbAccess()
+	{
+		return this.hasUsbAccess;
+	}
+}
-- 
cgit v1.2.3-55-g7522


From 46b8f8b5f69efebb0ae389cff6627d70f7633fc2 Mon Sep 17 00:00:00 2001
From: Manuel Bentele
Date: Wed, 28 Apr 2021 09:19:42 +0200
Subject: Document configuration transformation logics and their data
 containers

---
 ...onfigurationDataDozModClientToDozModServer.java | 11 ++++
 ...onfigurationDataDozModServerToDozModClient.java | 65 ++++++++++++++++++++++
 ...igurationDataDozModServerToStatelessClient.java | 47 ++++++++++++++++
 .../configuration/logic/ConfigurationLogic.java    | 16 ++++++
 ...nfigurationLogicDozModClientToDozModServer.java | 32 +++++++++++
 ...nfigurationLogicDozModServerToDozModClient.java | 60 ++++++++++++++++++++
 ...gurationLogicDozModServerToStatelessClient.java | 35 ++++++++++++
 7 files changed, 266 insertions(+)

(limited to 'src/main/java/org/openslx/virtualization/configuration/data')

diff --git a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModClientToDozModServer.java b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModClientToDozModServer.java
index dda62aa..0d0c457 100644
--- a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModClientToDozModServer.java
+++ b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModClientToDozModServer.java
@@ -1,7 +1,18 @@
 package org.openslx.virtualization.configuration.data;
 
+/**
+ * Data container to collect and store input arguments for a
+ * {@link ConfigurationLogicDozModClientToDozModServer} transformation.
+ * 
+ * @author Manuel Bentele
+ * @version 1.0
+ */
 public class ConfigurationDataDozModClientToDozModServer
 {
+	/**
+	 * Creates a new data container to collect and store input arguments for a
+	 * {@link ConfigurationLogicDozModClientToDozModServer} transformation.
+	 */
 	public ConfigurationDataDozModClientToDozModServer()
 	{
 	}
diff --git a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java
index c1ae37a..7b1c0b4 100644
--- a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java
+++ b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java
@@ -4,14 +4,52 @@ import java.io.File;
 
 import org.openslx.bwlp.thrift.iface.OperatingSystem;
 
+/**
+ * Data container to collect and store input arguments for a
+ * {@link ConfigurationLogicDozModServerToDozModClient} transformation.
+ * 
+ * @author Manuel Bentele
+ * @version 1.0
+ */
 public class ConfigurationDataDozModServerToDozModClient
 {
+	/**
+	 * Display name for a transformation of a virtualization configuration.
+	 */
 	private final String displayName;
+
+	/**
+	 * Disk image file for a transformation of a virtualization configuration.
+	 */
 	private final File diskImage;
+
+	/**
+	 * Guest operating system for a transformation of a virtualization configuration.
+	 */
 	private final OperatingSystem guestOs;
+
+	/**
+	 * Virtualizer identifier for a transformation of a virtualization configuration.
+	 */
 	private final String virtualizerId;
+
+	/**
+	 * Total amount of available memory for a transformation of a virtualization configuration.
+	 */
 	private final int totalMemory;
 
+	/**
+	 * Creates a new data container to collect and store input arguments for a
+	 * {@link ConfigurationLogicDozModServerToDozModClient} transformation.
+	 * 
+	 * @param displayName display name for a transformation of a virtualization configuration.
+	 * @param diskImage disk image file for a transformation of a virtualization configuration.
+	 * @param guestOs guest operating system for a transformation of a virtualization configuration.
+	 * @param virtualizerId virtualizer identifier for a transformation of a virtualization
+	 *           configuration.
+	 * @param totalMemory total amount of available memory for a transformation of a virtualization
+	 *           configuration.
+	 */
 	public ConfigurationDataDozModServerToDozModClient( String displayName, File diskImage, OperatingSystem guestOs,
 			String virtualizerId, int totalMemory )
 	{
@@ -22,26 +60,53 @@ public class ConfigurationDataDozModServerToDozModClient
 		this.totalMemory = totalMemory;
 	}
 
+	/**
+	 * Returns the display name for a transformation of a virtualization configuration.
+	 * 
+	 * @return display name for a transformation of a virtualization configuration.
+	 */
 	public String getDisplayName()
 	{
 		return this.displayName;
 	}
 
+	/**
+	 * Returns the disk image file for a transformation of a virtualization configuration.
+	 * 
+	 * @return disk image file for a transformation of a virtualization configuration.
+	 */
 	public File getDiskImage()
 	{
 		return this.diskImage;
 	}
 
+	/**
+	 * Returns the guest operating system for a transformation of a virtualization configuration.
+	 * 
+	 * @return guest operating system for a transformation of a virtualization configuration.
+	 */
 	public OperatingSystem getGuestOs()
 	{
 		return this.guestOs;
 	}
 
+	/**
+	 * Returns the virtualizer identifier for a transformation of a virtualization configuration.
+	 * 
+	 * @return virtualizer identifier for a transformation of a virtualization configuration.
+	 */
 	public String getVirtualizerId()
 	{
 		return this.virtualizerId;
 	}
 
+	/**
+	 * Returns the total amount of available memory for a transformation of a virtualization
+	 * configuration.
+	 * 
+	 * @return total amount of available memory for a transformation of a virtualization
+	 *         configuration.
+	 */
 	public int getTotalMemory()
 	{
 		return this.totalMemory;
diff --git a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToStatelessClient.java b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToStatelessClient.java
index f5d9a31..e92df92 100644
--- a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToStatelessClient.java
+++ b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToStatelessClient.java
@@ -1,11 +1,40 @@
 package org.openslx.virtualization.configuration.data;
 
+/**
+ * Data container to collect and store input arguments for a
+ * {@link ConfigurationLogicDozModServerToStatelessClient} transformation.
+ * 
+ * @author Manuel Bentele
+ * @version 1.0
+ */
 public class ConfigurationDataDozModServerToStatelessClient
 {
+	/**
+	 * Display name for a transformation of a virtualization configuration.
+	 */
 	private final String displayName;
+
+	/**
+	 * Operating system identifier for a transformation of a virtualization configuration.
+	 */
 	private final String osId;
+
+	/**
+	 * State whether USB access is allowed or not for a transformation of a virtualization
+	 * configuration.
+	 */
 	private final boolean hasUsbAccess;
 
+	/**
+	 * Creates a new data container to collect and store input arguments for a
+	 * {@link ConfigurationLogicDozModServerToStatelessClient} transformation.
+	 * 
+	 * @param displayName display name for a transformation of a virtualization configuration.
+	 * @param osId operating system identifier for a transformation of a virtualization
+	 *           configuration.
+	 * @param hasUsbAccess state whether USB access is allowed or not for a transformation of a
+	 *           virtualization configuration.
+	 */
 	public ConfigurationDataDozModServerToStatelessClient( String displayName, String osId, boolean hasUsbAccess )
 	{
 		this.displayName = displayName;
@@ -13,16 +42,34 @@ public class ConfigurationDataDozModServerToStatelessClient
 		this.hasUsbAccess = hasUsbAccess;
 	}
 
+	/**
+	 * Returns the display name for a transformation of a virtualization configuration.
+	 * 
+	 * @return display name for a transformation of a virtualization configuration.
+	 */
 	public String getDisplayName()
 	{
 		return this.displayName;
 	}
 
+	/**
+	 * Returns the operating system identifier for a transformation of a virtualization
+	 * configuration.
+	 * 
+	 * @return operating system identifier for a transformation of a virtualization configuration.
+	 */
 	public String getOsId()
 	{
 		return this.osId;
 	}
 
+	/**
+	 * Returns the state whether USB access is allowed or not for a transformation of a
+	 * virtualization configuration.
+	 * 
+	 * @return state whether USB access is allowed or not for a transformation of a virtualization
+	 *         configuration.
+	 */
 	public boolean hasUsbAccess()
 	{
 		return this.hasUsbAccess;
diff --git a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogic.java b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogic.java
index 1aac943..018d046 100644
--- a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogic.java
+++ b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogic.java
@@ -3,8 +3,24 @@ package org.openslx.virtualization.configuration.logic;
 import org.openslx.virtualization.configuration.VirtualizationConfiguration;
 import org.openslx.virtualization.configuration.transformation.TransformationGeneric;
 
+/**
+ * Generic transformation logic for virtualization configurations.
+ * <p>
+ * This transformation logic represents an encapsulated transformation logic to transform
+ * virtualization configurations as part of server or client implementations.
+ * 
+ * @author Manuel Bentele
+ * @version 1.0
+ * 
+ * @param <T> type of configuration data used as input arguments for a transformation.
+ */
 public abstract class ConfigurationLogic<T> extends TransformationGeneric<VirtualizationConfiguration<?, ?, ?, ?>, T>
 {
+	/**
+	 * Creates a new generic transformation logic for virtualization configurations.
+	 * 
+	 * @param name generic transformation logic name.
+	 */
 	public ConfigurationLogic( String name )
 	{
 		super( name );
diff --git a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModClientToDozModServer.java b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModClientToDozModServer.java
index ca25aa3..d64f42a 100644
--- a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModClientToDozModServer.java
+++ b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModClientToDozModServer.java
@@ -5,16 +5,48 @@ import org.openslx.virtualization.configuration.VirtualizationConfigurationExcep
 import org.openslx.virtualization.configuration.data.ConfigurationDataDozModClientToDozModServer;
 import org.openslx.virtualization.configuration.transformation.TransformationException;
 
+/**
+ * Transformation logic for virtualization configurations between a dozmod-client and a
+ * dozmod-server.
+ * <p>
+ * This transformation logic is applied while uploading a new virtualization configuration from a
+ * dozmod-client to a dozmod-server.
+ * 
+ * <pre>
+ *   +------------------------------+  DozModClientToDozModServer   +------------------------------+
+ *   | virtualization configuration | ----------------------------> | virtualization configuration |
+ *   +---------------+--------------+     transformation logic      +---------------+--------------+
+ *   | dozmod-client |                                              | dozmod-server |
+ *   +---------------+                                              +---------------+
+ * </pre>
+ * 
+ * @author Manuel Bentele
+ * @version 1.0
+ */
 public class ConfigurationLogicDozModClientToDozModServer
 		extends ConfigurationLogic<ConfigurationDataDozModClientToDozModServer>
 {
+	/**
+	 * Name of the transformation logic for virtualization configurations.
+	 */
 	private static final String CONFIGURATION_LOGIC_NAME = "Transformation of virtualization configuration during upload from DozMod client to DozMod server";
 
+	/**
+	 * Creates a new transformation logic for virtualization configurations between a dozmod-client
+	 * and a dozmod-server.
+	 */
 	public ConfigurationLogicDozModClientToDozModServer()
 	{
 		super( ConfigurationLogicDozModClientToDozModServer.CONFIGURATION_LOGIC_NAME );
 	}
 
+	/**
+	 * Validates a virtualization configuration and input arguments for a transformation.
+	 * 
+	 * @param config virtualization configuration for the validation.
+	 * @param args input arguments for the validation.
+	 * @throws TransformationException validation has failed.
+	 */
 	private void validateInputs( VirtualizationConfiguration<?, ?, ?, ?> config,
 			ConfigurationDataDozModClientToDozModServer args )
 			throws TransformationException
diff --git a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToDozModClient.java b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToDozModClient.java
index 6d8687f..05b3d4a 100644
--- a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToDozModClient.java
+++ b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToDozModClient.java
@@ -9,19 +9,60 @@ import org.openslx.virtualization.configuration.VirtualizationConfigurationExcep
 import org.openslx.virtualization.configuration.data.ConfigurationDataDozModServerToDozModClient;
 import org.openslx.virtualization.configuration.transformation.TransformationException;
 
+/**
+ * Transformation logic for virtualization configurations between a dozmod-server and a
+ * dozmod-client.
+ * <p>
+ * This transformation logic is applied while downloading an existing virtualization configuration
+ * from a dozmod-server to a dozmod-client.
+ * 
+ * <pre>
+ *   +------------------------------+  DozModServerToDozModClient   +------------------------------+
+ *   | virtualization configuration | ----------------------------> | virtualization configuration |
+ *   +---------------+--------------+     transformation logic      +---------------+--------------+
+ *   | dozmod-server |                                              | dozmod-client |
+ *   +---------------+                                              +---------------+
+ * </pre>
+ * 
+ * @author Manuel Bentele
+ * @version 1.0
+ */
 public class ConfigurationLogicDozModServerToDozModClient
 		extends ConfigurationLogic<ConfigurationDataDozModServerToDozModClient>
 {
+	/**
+	 * Name of the transformation logic for virtualization configurations.
+	 */
 	private static final String CONFIGURATION_LOGIC_NAME = "Transformation of virtualization configuration during download from DozMod server to DozMod client";
 
+	/**
+	 * Default number of CPU cores set by the configuration logic for the virtualization
+	 * configuration's virtualizer.
+	 */
 	private static final int CONFIGURATION_LOGIC_NUM_CPU_CORES = 1;
+
+	/**
+	 * Default memory in megabytes set by the configuration logic for the virtualization
+	 * configuration's virtualizer.
+	 */
 	private static final int CONFIGURATION_LOGIC_MEMORY_MIN = 1024;
 
+	/**
+	 * Creates a new transformation logic for virtualization configurations between a dozmod-server
+	 * and a dozmod-client.
+	 */
 	public ConfigurationLogicDozModServerToDozModClient()
 	{
 		super( ConfigurationLogicDozModServerToDozModClient.CONFIGURATION_LOGIC_NAME );
 	}
 
+	/**
+	 * Validates a virtualization configuration and input arguments for a transformation.
+	 * 
+	 * @param config virtualization configuration for the validation.
+	 * @param args input arguments for the validation.
+	 * @throws TransformationException validation has failed.
+	 */
 	private void validateInputs( VirtualizationConfiguration<?, ?, ?, ?> config,
 			ConfigurationDataDozModServerToDozModClient args )
 			throws TransformationException
@@ -37,11 +78,30 @@ public class ConfigurationLogicDozModServerToDozModClient
 		}
 	}
 
+	/**
+	 * Rounds a given value to the nearest factor.
+	 * 
+	 * @param value input value for the rounding.
+	 * @param nearestFactor nearest factor for the rounding.
+	 * @return rounded value as a multiple of the nearest factor.
+	 * 
+	 * @apiNote This utility method rounds the given value to an integer value and no to a floating
+	 *          point value.
+	 */
 	private static int roundToNearest( int value, int nearestFactor )
 	{
 		return ( value / nearestFactor ) * nearestFactor;
 	}
 
+	/**
+	 * Calculates the amount of memory for the virtualization configuration depending on the
+	 * available resources of the dozmod-client's host system.
+	 * 
+	 * @param totalMemory maximum memory available on the dozmod-client's host system.
+	 * @param osMaxMemory maximum memory supported by the defined operating system in the
+	 *           virtualization configuration.
+	 * @return amount of memory for the virtualization configuration in megabytes
+	 */
 	private static int calculateVirtualizationMemoryOnDozmodClient( int totalMemory, int osMaxMemory )
 	{
 		// calculate the amount of memory
diff --git a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToStatelessClient.java b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToStatelessClient.java
index 8697df1..6c573bb 100644
--- a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToStatelessClient.java
+++ b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToStatelessClient.java
@@ -7,18 +7,53 @@ import org.openslx.virtualization.configuration.VirtualizationConfigurationExcep
 import org.openslx.virtualization.configuration.data.ConfigurationDataDozModServerToStatelessClient;
 import org.openslx.virtualization.configuration.transformation.TransformationException;
 
+/**
+ * Transformation logic for virtualization configurations between a dozmod-server and a stateless
+ * client.
+ * <p>
+ * This transformation logic is applied while downloading an existing virtualization configuration
+ * from a dozmod-server to a stateless client.
+ * 
+ * <pre>
+ *   +------------------------------+  DozModServerToStatelessClient   +------------------------------+
+ *   | virtualization configuration | -------------------------------> | virtualization configuration |
+ *   +---------------+--------------+      transformation logic        +------------------+-----------+
+ *   | dozmod-server |                                                 | stateless client |
+ *   +---------------+                                                 +------------------+
+ * </pre>
+ * 
+ * @author Manuel Bentele
+ * @version 1.0
+ */
 public class ConfigurationLogicDozModServerToStatelessClient
 		extends ConfigurationLogic<ConfigurationDataDozModServerToStatelessClient>
 {
+	/**
+	 * Name of the transformation logic for virtualization configurations.
+	 */
 	private static final String CONFIGURATION_LOGIC_NAME = "Transformation of virtualization configuration during download from DozMod server to stateless client";
 
+	/**
+	 * Default type for an ethernet interface in a virtualization configuration.
+	 */
 	private static final EtherType CONFIGURATION_DEFAULT_ETHERNET_TYPE = EtherType.NAT;
 
+	/**
+	 * Creates a new transformation logic for virtualization configurations between a dozmod-server
+	 * and a stateless client.
+	 */
 	public ConfigurationLogicDozModServerToStatelessClient()
 	{
 		super( ConfigurationLogicDozModServerToStatelessClient.CONFIGURATION_LOGIC_NAME );
 	}
 
+	/**
+	 * Validates a virtualization configuration and input arguments for a transformation.
+	 * 
+	 * @param config virtualization configuration for the validation.
+	 * @param args input arguments for the validation.
+	 * @throws TransformationException validation has failed.
+	 */
 	private void validateInputs( VirtualizationConfiguration<?, ?, ?, ?> config,
 			ConfigurationDataDozModServerToStatelessClient args )
 			throws TransformationException
-- 
cgit v1.2.3-55-g7522


From c5d35cf6b739444ba0d065203d8f21db86d0c8c1 Mon Sep 17 00:00:00 2001
From: Manuel Bentele
Date: Fri, 30 Apr 2021 12:11:32 +0200
Subject: Fix errors in Javadoc comments

---
 .../java/org/openslx/libvirt/domain/Domain.java    |  2 +-
 .../libvirt/domain/device/ControllerUsb.java       |  2 +-
 .../org/openslx/libvirt/domain/device/Disk.java    |  2 +-
 .../openslx/libvirt/domain/device/HostdevPci.java  |  2 +-
 .../openslx/libvirt/domain/device/Interface.java   |  6 +-
 .../org/openslx/libvirt/domain/device/Sound.java   |  2 +-
 .../org/openslx/libvirt/domain/device/Video.java   |  2 +-
 .../openslx/libvirt/xml/LibvirtXmlEditable.java    | 72 +++++++++++-----------
 .../org/openslx/libvirt/xml/LibvirtXmlNode.java    | 22 +++----
 .../libvirt/xml/LibvirtXmlSchemaValidator.java     |  5 +-
 .../libvirt/xml/LibvirtXmlSerializable.java        | 12 ++++
 .../java/org/openslx/virtualization/Version.java   |  2 +-
 .../configuration/VirtualizationConfiguration.java |  9 ++-
 .../VirtualizationConfigurationQemuUtils.java      |  2 +-
 ...alizationConfigurationVirtualboxFileFormat.java |  9 +--
 ...onfigurationDataDozModClientToDozModServer.java |  6 +-
 ...onfigurationDataDozModServerToDozModClient.java |  6 +-
 ...igurationDataDozModServerToStatelessClient.java |  6 +-
 ...nfigurationLogicDozModClientToDozModServer.java |  2 +-
 ...nfigurationLogicDozModServerToDozModClient.java |  2 +-
 ...gurationLogicDozModServerToStatelessClient.java |  2 +-
 .../transformation/TransformationSpecific.java     |  1 +
 src/main/java/org/openslx/vm/disk/DiskImage.java   |  2 +-
 .../java/org/openslx/vm/disk/DiskImageQcow2.java   |  4 +-
 .../java/org/openslx/vm/disk/DiskImageUtils.java   |  8 +--
 .../java/org/openslx/vm/disk/DiskImageVmdk.java    |  3 +-
 26 files changed, 109 insertions(+), 84 deletions(-)

(limited to 'src/main/java/org/openslx/virtualization/configuration/data')

diff --git a/src/main/java/org/openslx/libvirt/domain/Domain.java b/src/main/java/org/openslx/libvirt/domain/Domain.java
index dbc60e6..c8f5303 100644
--- a/src/main/java/org/openslx/libvirt/domain/Domain.java
+++ b/src/main/java/org/openslx/libvirt/domain/Domain.java
@@ -603,7 +603,7 @@ public class Domain extends LibvirtXmlDocument
 		/**
 		 * Creates a CPU check from its name with error check.
 		 * 
-		 * @param mode name of the CPU check in the Libvirt domain XML document.
+		 * @param check name of the CPU check in the Libvirt domain XML document.
 		 * @return valid CPU check.
 		 */
 		public static CpuCheck fromString( String check )
diff --git a/src/main/java/org/openslx/libvirt/domain/device/ControllerUsb.java b/src/main/java/org/openslx/libvirt/domain/device/ControllerUsb.java
index 695167c..1798027 100644
--- a/src/main/java/org/openslx/libvirt/domain/device/ControllerUsb.java
+++ b/src/main/java/org/openslx/libvirt/domain/device/ControllerUsb.java
@@ -122,7 +122,7 @@ public class ControllerUsb extends Controller
 		/**
 		 * Creates USB controller device model from its name with error check.
 		 * 
-		 * @param type name of the USB controller device model in a Libvirt domain XML document.
+		 * @param model name of the USB controller device model in a Libvirt domain XML document.
 		 * @return valid USB controller device model.
 		 */
 		public static Model fromString( String model )
diff --git a/src/main/java/org/openslx/libvirt/domain/device/Disk.java b/src/main/java/org/openslx/libvirt/domain/device/Disk.java
index d9007f5..7694538 100644
--- a/src/main/java/org/openslx/libvirt/domain/device/Disk.java
+++ b/src/main/java/org/openslx/libvirt/domain/device/Disk.java
@@ -195,7 +195,7 @@ public class Disk extends Device
 	/**
 	 * Sets target device for the disk device.
 	 * 
-	 * @param target device for the disk device.
+	 * @param targetDevice target device for the disk device.
 	 */
 	public void setTargetDevice( String targetDevice )
 	{
diff --git a/src/main/java/org/openslx/libvirt/domain/device/HostdevPci.java b/src/main/java/org/openslx/libvirt/domain/device/HostdevPci.java
index 3b26fb0..a0563f2 100644
--- a/src/main/java/org/openslx/libvirt/domain/device/HostdevPci.java
+++ b/src/main/java/org/openslx/libvirt/domain/device/HostdevPci.java
@@ -48,7 +48,7 @@ public class HostdevPci extends Hostdev
 	 * detached from the host before being passed on to the guest and reattached to the host after
 	 * the guest exits.
 	 * 
-	 * @return state whether PCI hostdev device is managed.
+	 * @param managed state whether PCI hostdev device is managed or not.
 	 */
 	public void setManaged( boolean managed )
 	{
diff --git a/src/main/java/org/openslx/libvirt/domain/device/Interface.java b/src/main/java/org/openslx/libvirt/domain/device/Interface.java
index dae3c11..44b8e4c 100644
--- a/src/main/java/org/openslx/libvirt/domain/device/Interface.java
+++ b/src/main/java/org/openslx/libvirt/domain/device/Interface.java
@@ -62,8 +62,8 @@ public class Interface extends Device
 
 	/**
 	 * Sets type of the network device.
-	 * 
-	 * @return type of the network device.
+	 *  
+	 * @param type network device type.
 	 */
 	public void setType( Type type )
 	{
@@ -327,7 +327,7 @@ public class Interface extends Device
 		/**
 		 * Creates network interface device model from its name with error check.
 		 * 
-		 * @param type name of the network interface device model in a Libvirt domain XML document.
+		 * @param model name of the network interface device model in a Libvirt domain XML document.
 		 * @return valid network interface device model.
 		 */
 		public static Model fromString( String model )
diff --git a/src/main/java/org/openslx/libvirt/domain/device/Sound.java b/src/main/java/org/openslx/libvirt/domain/device/Sound.java
index e424ed4..dfeeffd 100644
--- a/src/main/java/org/openslx/libvirt/domain/device/Sound.java
+++ b/src/main/java/org/openslx/libvirt/domain/device/Sound.java
@@ -111,7 +111,7 @@ public class Sound extends Device
 		/**
 		 * Creates sound device model from its name with error check.
 		 * 
-		 * @param type name of the sound device model in a Libvirt domain XML document.
+		 * @param model name of the sound device model in a Libvirt domain XML document.
 		 * @return valid sound device model.
 		 */
 		public static Model fromString( String model )
diff --git a/src/main/java/org/openslx/libvirt/domain/device/Video.java b/src/main/java/org/openslx/libvirt/domain/device/Video.java
index e901b85..0f8861f 100644
--- a/src/main/java/org/openslx/libvirt/domain/device/Video.java
+++ b/src/main/java/org/openslx/libvirt/domain/device/Video.java
@@ -171,7 +171,7 @@ public class Video extends Device
 		/**
 		 * Creates video device model from its name with error check.
 		 * 
-		 * @param type name of the video device model in a Libvirt domain XML document.
+		 * @param model name of the video device model in a Libvirt domain XML document.
 		 * @return valid video device model.
 		 */
 		public static Model fromString( String model )
diff --git a/src/main/java/org/openslx/libvirt/xml/LibvirtXmlEditable.java b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlEditable.java
index 1ddddce..40d7b86 100644
--- a/src/main/java/org/openslx/libvirt/xml/LibvirtXmlEditable.java
+++ b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlEditable.java
@@ -4,7 +4,7 @@ import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 
 /**
- * Editability of XML nodes based on {@link XPath} expressions.
+ * Editability of XML nodes based on XPath expressions.
  * 
  * @author Manuel Bentele
  * @version 1.0
@@ -12,17 +12,17 @@ import org.w3c.dom.NodeList;
 public interface LibvirtXmlEditable
 {
 	/**
-	 * Returns XML node selected by a {@link XPath} expression
+	 * Returns XML node selected by a XPath expression
 	 * 
-	 * @param expression {@link XPath} expression to select XML node.
+	 * @param expression XPath expression to select XML node.
 	 * @return selected XML node.
 	 */
 	public Node getXmlNode( String expression );
 
 	/**
-	 * Returns XML nodes selected by a {@link XPath} expression
+	 * Returns XML nodes selected by a XPath expression
 	 * 
-	 * @param expression {@link XPath} expression to select XML nodes.
+	 * @param expression XPath expression to select XML nodes.
 	 * @return selected XML nodes.
 	 */
 	public NodeList getXmlNodes( String expression );
@@ -38,20 +38,20 @@ public interface LibvirtXmlEditable
 	}
 
 	/**
-	 * Returns XML element from selection by a {@link XPath} expression.
+	 * Returns XML element from selection by a XPath expression.
 	 * 
-	 * @param expression {@link XPath} expression to select XML element.
+	 * @param expression XPath expression to select XML element.
 	 * @return selected XML element.
 	 */
 	public Node getXmlElement( String expression );
 
 	/**
-	 * Sets an XML element selected by a {@link XPath} expression.
+	 * Sets an XML element selected by a XPath expression.
 	 * 
-	 * If the XML element selected by the given {@link XPath} expression does not exists, the XML
+	 * If the XML element selected by the given XPath expression does not exists, the XML
 	 * element will be created.
 	 * 
-	 * @param expression {@link XPath} expression to select XML element.
+	 * @param expression XPath expression to select XML element.
 	 */
 	public default void setXmlElement( String expression )
 	{
@@ -59,43 +59,43 @@ public interface LibvirtXmlEditable
 	}
 
 	/**
-	 * Sets a XML element selected by a {@link XPath} expression and appends child XML node.
+	 * Sets a XML element selected by a XPath expression and appends child XML node.
 	 * 
-	 * If the XML element selected by the given {@link XPath} expression does not exists, the XML
+	 * If the XML element selected by the given XPath expression does not exists, the XML
 	 * element will be created and the given XML child node is appended.
 	 * 
-	 * @param expression {@link XPath} expression to select XML element.
+	 * @param expression XPath expression to select XML element.
 	 * @param child XML node that will be appended to the selected XML element.
 	 */
 	public void setXmlElement( String expression, Node child );
 
 	/**
-	 * Returns the text value of a XML element selected by a {@link XPath} expression.
+	 * Returns the text value of a XML element selected by a XPath expression.
 	 * 
-	 * @param expression {@link XPath} expression to select XML element.
+	 * @param expression XPath expression to select XML element.
 	 * @return Text value of the selected XML element.
 	 */
 	public String getXmlElementValue( String expression );
 
 	/**
-	 * Sets the text value of a XML element selected by a {@link XPath} expression.
+	 * Sets the text value of a XML element selected by a XPath expression.
 	 * 
-	 * @param expression {@link XPath} expression to select XML element.
+	 * @param expression XPath expression to select XML element.
 	 * @param value text value to set selected XML element's text.
 	 */
 	public void setXmlElementValue( String expression, String value );
 
 	/**
-	 * Removes a XML element and all its childs selected by a {@link XPath} expression.
+	 * Removes a XML element and all its childs selected by a XPath expression.
 	 * 
-	 * @param expression {@link XPath} expression to select XML element.
+	 * @param expression XPath expression to select XML element.
 	 */
 	public void removeXmlElement( String expression );
 
 	/**
-	 * Removes all child elements of a XML element selected by a {@link XPath} expression.
+	 * Removes all child elements of a XML element selected by a XPath expression.
 	 * 
-	 * @param expression {@link XPath} expression to select XML element.
+	 * @param expression XPath expression to select XML element.
 	 */
 	public void removeXmlElementChilds( String expression );
 
@@ -128,14 +128,14 @@ public interface LibvirtXmlEditable
 	}
 
 	/**
-	 * Returns the binary choice of a XML attribute from a XML element selected by a
-	 * {@link XPath}expression.
+	 * Returns the binary choice of a XML attribute from a XML element selected by a XPath
+	 * expression.
 	 * 
 	 * If the text value of the XML attribute equals to <i>yes</i>, the returned {@link boolean}
 	 * value is set to <i>true</i>. Otherwise, if the text value of the XML attribute equals to
 	 * <i>no</i>, the returned {@link boolean} value is set to <i>false</i>.
 	 * 
-	 * @param expression {@link XPath} expression to select XML element.
+	 * @param expression XPath expression to select XML element.
 	 * @param attributeName name to select XML attribute of the current XML root element.
 	 * @return attribute value of the XML attribute from the current XML root element as
 	 *         {@link boolean}.
@@ -146,10 +146,9 @@ public interface LibvirtXmlEditable
 	}
 
 	/**
-	 * Returns the text value of a XML attribute from a XML element selected by a
-	 * {@link XPath}expression.
+	 * Returns the text value of a XML attribute from a XML element selected by a XPath expression.
 	 * 
-	 * @param expression {@link XPath} expression to select XML element.
+	 * @param expression XPath expression to select XML element.
 	 * @param attributeName name to select XML attribute of the selected XML element.
 	 * @return attribute text of the XML attribute from the selected XML element.
 	 */
@@ -185,15 +184,15 @@ public interface LibvirtXmlEditable
 	}
 
 	/**
-	 * Sets the binary choice value of a XML attribute from a XML element selected by a
-	 * {@link XPath} expression.
+	 * Sets the binary choice value of a XML attribute from a XML element selected by a XPath
+	 * expression.
 	 * 
 	 * If the binary choice value for the XML attribute equals to <i>true</i>, the text value of the
 	 * selected XML attribute is set to <i>yes</i>. Otherwise, if the binary choice value for the
 	 * selected XML attribute equals to <i>false</i>, the text value of the selected XML attribute is
 	 * set to <i>no</i>.
 	 * 
-	 * @param expression {@link XPath} expression to select XML element.
+	 * @param expression XPath expression to select XML element.
 	 * @param attributeName name to select XML attribute of the selected XML element.
 	 * @param value binary choice value for the selected XML attribute from the selected XML element.
 	 */
@@ -204,10 +203,9 @@ public interface LibvirtXmlEditable
 	}
 
 	/**
-	 * Sets the text value of a XML attribute from a XML element selected by a
-	 * {@link XPath} expression.
+	 * Sets the text value of a XML attribute from a XML element selected by a XPath expression.
 	 * 
-	 * @param expression {@link XPath} expression to select XML element.
+	 * @param expression XPath expression to select XML element.
 	 * @param attributeName name to select XML attribute of the selected XML element.
 	 * @param value XML attribute value for the selected XML attribute from the selected XML element.
 	 */
@@ -224,17 +222,17 @@ public interface LibvirtXmlEditable
 	}
 
 	/**
-	 * Removes an XML attribute from a XML element selected by a {@link XPath} expression.
+	 * Removes an XML attribute from a XML element selected by a XPath expression.
 	 * 
-	 * @param expression {@link XPath} expression to select XML element.
+	 * @param expression XPath expression to select XML element.
 	 * @param attributeName name of the attribute which should be deleted.
 	 */
 	public void removeXmlElementAttribute( String expression, String attributeName );
 
 	/**
-	 * Removes all XML attributes from a XML element selected by a {@link XPath} expression.
+	 * Removes all XML attributes from a XML element selected by a XPath expression.
 	 * 
-	 * @param expression {@link XPath} expression to select XML element.
+	 * @param expression XPath expression to select XML element.
 	 */
 	public void removeXmlElementAttributes( String expression );
 
diff --git a/src/main/java/org/openslx/libvirt/xml/LibvirtXmlNode.java b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlNode.java
index 93e28de..6d00271 100644
--- a/src/main/java/org/openslx/libvirt/xml/LibvirtXmlNode.java
+++ b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlNode.java
@@ -12,7 +12,7 @@ import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 
 /**
- * A representation of a XML node as part of a {@link LibvirtXMLDocument}.
+ * A representation of a XML node as part of a {@link LibvirtXmlDocument}.
  * 
  * @author Manuel Bentele
  * @version 1.0
@@ -20,17 +20,17 @@ import org.w3c.dom.NodeList;
 public class LibvirtXmlNode implements LibvirtXmlCreatable, LibvirtXmlEditable
 {
 	/**
-	 * Separation character for internal {@link XPath} expressions.
+	 * Separation character for internal XPath expressions.
 	 */
 	private static final String XPATH_EXPRESSION_SEPARATOR = "/";
 
 	/**
-	 * Current XML node selection character for internal {@link XPath} expressions.
+	 * Current XML node selection character for internal XPath expressions.
 	 */
 	private static final String XPATH_EXPRESSION_CURRENT_NODE = ".";
 
 	/**
-	 * Factory to create {@link XPath} objects.
+	 * Factory to create XPath objects.
 	 */
 	private XPathFactory xPathFactory = null;
 
@@ -40,13 +40,12 @@ public class LibvirtXmlNode implements LibvirtXmlCreatable, LibvirtXmlEditable
 	private Document xmlDocument = null;
 
 	/**
-	 * Current XML base node as XML root anchor for relative internal {@link XPath} expressions.
+	 * Current XML base node as XML root anchor for relative internal XPath expressions.
 	 */
 	private Node xmlBaseNode = null;
 
 	/**
-	 * Create and initialize {@link XPath} context to define and compile custom {@link XPath}
-	 * expressions.
+	 * Create and initialize XPath context to define and compile custom XPath expressions.
 	 */
 	private void createXPathContext()
 	{
@@ -139,8 +138,7 @@ public class LibvirtXmlNode implements LibvirtXmlCreatable, LibvirtXmlEditable
 	/**
 	 * Returns current XML base node.
 	 * 
-	 * @return current XML base node as XML root anchor of relative internal {@link XPath}
-	 *         expressions.
+	 * @return current XML base node as XML root anchor of relative internal XPath expressions.
 	 */
 	public Node getXmlBaseNode()
 	{
@@ -150,8 +148,8 @@ public class LibvirtXmlNode implements LibvirtXmlCreatable, LibvirtXmlEditable
 	/**
 	 * Sets existing XML base node for Libvirt XML node.
 	 * 
-	 * @param xmlBaseNode existing XML base node as XML root anchor for relative internal
-	 *           {@link XPath} expressions.
+	 * @param xmlBaseNode existing XML base node as XML root anchor for relative internal XPath
+	 *           expressions.
 	 */
 	public void setXmlBaseNode( Node xmlBaseNode )
 	{
@@ -317,7 +315,7 @@ public class LibvirtXmlNode implements LibvirtXmlCreatable, LibvirtXmlEditable
 			attribute.setNodeValue( value );
 		}
 	}
-	
+
 	@Override
 	public void removeXmlElementAttribute( String expression, String attributeName )
 	{
diff --git a/src/main/java/org/openslx/libvirt/xml/LibvirtXmlSchemaValidator.java b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlSchemaValidator.java
index e074948..bc8f90f 100644
--- a/src/main/java/org/openslx/libvirt/xml/LibvirtXmlSchemaValidator.java
+++ b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlSchemaValidator.java
@@ -196,8 +196,9 @@ public class LibvirtXmlSchemaValidator
 	/**
 	 * Creates a validator for validation of Libvirt XML documents with RelaxNG schemas.
 	 * 
-	 * @param rngSchema
-	 * @throws SAXException
+	 * @param rngSchema RelaxNG schema used for validation with {@link #validate(Document)}.
+	 * 
+	 * @throws SAXException creation of a Libvirt XML validator failed.
 	 */
 	public LibvirtXmlSchemaValidator( InputStream rngSchema ) throws SAXException
 	{
diff --git a/src/main/java/org/openslx/libvirt/xml/LibvirtXmlSerializable.java b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlSerializable.java
index 6f11ce5..4cd0a32 100644
--- a/src/main/java/org/openslx/libvirt/xml/LibvirtXmlSerializable.java
+++ b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlSerializable.java
@@ -17,6 +17,8 @@ public abstract interface LibvirtXmlSerializable
 	 * Serialize Libvirt XML document from {@link String}.
 	 * 
 	 * @param xml {@link String} containing XML content.
+	 * 
+	 * @throws LibvirtXmlSerializationException serialization of Libvirt XML document failed.
 	 */
 	public void fromXml( String xml ) throws LibvirtXmlSerializationException;
 
@@ -24,6 +26,8 @@ public abstract interface LibvirtXmlSerializable
 	 * Serialize Libvirt XML document from {@link File}.
 	 * 
 	 * @param xml {@link File} containing XML content.
+	 * 
+	 * @throws LibvirtXmlSerializationException serialization of Libvirt XML document failed.
 	 */
 	public void fromXml( File xml ) throws LibvirtXmlSerializationException;
 
@@ -31,6 +35,8 @@ public abstract interface LibvirtXmlSerializable
 	 * Serialize Libvirt XML document from {@link InputStream}.
 	 * 
 	 * @param xml {@link InputStream} providing XML content.
+	 * 
+	 * @throws LibvirtXmlSerializationException serialization of Libvirt XML document failed.
 	 */
 	void fromXml( InputStream xml ) throws LibvirtXmlSerializationException;
 
@@ -38,6 +44,8 @@ public abstract interface LibvirtXmlSerializable
 	 * Serialize Libvirt XML document from {@link InputSource}.
 	 * 
 	 * @param xml {@link InputSource} providing XML content.
+	 * 
+	 * @throws LibvirtXmlSerializationException serialization of Libvirt XML document failed.
 	 */
 	public void fromXml( InputSource xml ) throws LibvirtXmlSerializationException;
 
@@ -45,6 +53,8 @@ public abstract interface LibvirtXmlSerializable
 	 * Serialize Libvirt XML document to {@link String}.
 	 * 
 	 * @return XML {@link String} containing Libvirt XML document content.
+	 * 
+	 * @throws LibvirtXmlSerializationException serialization of Libvirt XML document failed.
 	 */
 	public String toXml() throws LibvirtXmlSerializationException;
 
@@ -52,6 +62,8 @@ public abstract interface LibvirtXmlSerializable
 	 * Serialize Libvirt XML document to {@link File}.
 	 * 
 	 * @param xml XML {@link File} containing Libvirt XML document content.
+	 * 
+	 * @throws LibvirtXmlSerializationException serialization of Libvirt XML document failed.
 	 */
 	public void toXml( File xml ) throws LibvirtXmlSerializationException;
 }
diff --git a/src/main/java/org/openslx/virtualization/Version.java b/src/main/java/org/openslx/virtualization/Version.java
index efc23af..5d99ac1 100644
--- a/src/main/java/org/openslx/virtualization/Version.java
+++ b/src/main/java/org/openslx/virtualization/Version.java
@@ -24,7 +24,7 @@ public class Version implements Comparable<Version>
 	 * The version consists of a major version, whereas the minor version is set to the value
 	 * <code>0</code> and the version name is undefined.
 	 * 
-	 * @param major
+	 * @param major major version.
 	 */
 	public Version( short major )
 	{
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 )
diff --git a/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfigurationQemuUtils.java b/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfigurationQemuUtils.java
index 7ac3632..0288029 100644
--- a/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfigurationQemuUtils.java
+++ b/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfigurationQemuUtils.java
@@ -116,7 +116,7 @@ public class VirtualizationConfigurationQemuUtils
 	/**
 	 * Converts a Libvirt network device model to a VM metadata ethernet device type.
 	 * 
-	 * @param soundDeviceModel Libvirt network device model.
+	 * @param networkDeviceModel Libvirt network device model.
 	 * @return VM metadata ethernet device type.
 	 */
 	public static EthernetDevType convertNetworkDeviceModel( Interface.Model networkDeviceModel )
diff --git a/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfigurationVirtualboxFileFormat.java b/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfigurationVirtualboxFileFormat.java
index 6a1f5a5..a0e1a1f 100644
--- a/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfigurationVirtualboxFileFormat.java
+++ b/src/main/java/org/openslx/virtualization/configuration/VirtualizationConfigurationVirtualboxFileFormat.java
@@ -116,7 +116,7 @@ public class VirtualizationConfigurationVirtualboxFileFormat
 	 * 
 	 * @param machineDescription content of the XML file saved as a byte array.
 	 * @param length of the machine description byte array.
-	 * @throws IOException if an
+	 * @throws VirtualizationConfigurationException creation of VirtualBox configuration file representation failed.
 	 */
 	public VirtualizationConfigurationVirtualboxFileFormat( byte[] machineDescription, int length ) throws VirtualizationConfigurationException
 	{
@@ -313,7 +313,7 @@ public class VirtualizationConfigurationVirtualboxFileFormat
 	/**
 	 * Function finds and saves the name of the guest OS
 	 * 
-	 * @throws XPathExpressionException
+	 * @throws XPathExpressionException failed to find and retrieve name of the guest OS.
 	 */
 	public void setOsType() throws XPathExpressionException
 	{
@@ -336,7 +336,7 @@ public class VirtualizationConfigurationVirtualboxFileFormat
 	/**
 	 * Search for attached hard drives and determine their controller and their path.
 	 *
-	 * @throws XPathExpressionException
+	 * @throws XPathExpressionException failed to find attached hard drives and their controllers.
 	 */
 	public void setHdds() throws XPathExpressionException
 	{
@@ -452,6 +452,7 @@ public class VirtualizationConfigurationVirtualboxFileFormat
 	 * @param elementXPath given as an xpath expression
 	 * @param attribute attribute to change
 	 * @param value to set the attribute to
+	 * @return state of the change operation whether the attribute was changed successful or not.
 	 */
 	public boolean changeAttribute( String elementXPath, String attribute, String value )
 	{
@@ -491,7 +492,7 @@ public class VirtualizationConfigurationVirtualboxFileFormat
 	 * Adds a new node named nameOfNewNode to the given parent found by parentXPath.
 	 *
 	 * @param parentXPath XPath expression to the parent
-	 * @param nameOfnewNode name of the node to be added
+	 * @param childName name of the node to be added
 	 * @return the newly added Node
 	 */
 	public Node addNewNode( String parentXPath, String childName )
diff --git a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModClientToDozModServer.java b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModClientToDozModServer.java
index 0d0c457..8a08d05 100644
--- a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModClientToDozModServer.java
+++ b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModClientToDozModServer.java
@@ -2,7 +2,8 @@ package org.openslx.virtualization.configuration.data;
 
 /**
  * Data container to collect and store input arguments for a
- * {@link ConfigurationLogicDozModClientToDozModServer} transformation.
+ * {@link org.openslx.virtualization.configuration.logic.ConfigurationLogicDozModClientToDozModServer}
+ * transformation.
  * 
  * @author Manuel Bentele
  * @version 1.0
@@ -11,7 +12,8 @@ public class ConfigurationDataDozModClientToDozModServer
 {
 	/**
 	 * Creates a new data container to collect and store input arguments for a
-	 * {@link ConfigurationLogicDozModClientToDozModServer} transformation.
+	 * {@link org.openslx.virtualization.configuration.logic.ConfigurationLogicDozModClientToDozModServer}
+	 * transformation.
 	 */
 	public ConfigurationDataDozModClientToDozModServer()
 	{
diff --git a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java
index 7b1c0b4..4e18d48 100644
--- a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java
+++ b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java
@@ -6,7 +6,8 @@ import org.openslx.bwlp.thrift.iface.OperatingSystem;
 
 /**
  * Data container to collect and store input arguments for a
- * {@link ConfigurationLogicDozModServerToDozModClient} transformation.
+ * {@link org.openslx.virtualization.configuration.logic.ConfigurationLogicDozModServerToDozModClient}
+ * transformation.
  * 
  * @author Manuel Bentele
  * @version 1.0
@@ -40,7 +41,8 @@ public class ConfigurationDataDozModServerToDozModClient
 
 	/**
 	 * Creates a new data container to collect and store input arguments for a
-	 * {@link ConfigurationLogicDozModServerToDozModClient} transformation.
+	 * {@link org.openslx.virtualization.configuration.logic.ConfigurationLogicDozModServerToDozModClient}
+	 * transformation.
 	 * 
 	 * @param displayName display name for a transformation of a virtualization configuration.
 	 * @param diskImage disk image file for a transformation of a virtualization configuration.
diff --git a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToStatelessClient.java b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToStatelessClient.java
index e92df92..65cc7ce 100644
--- a/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToStatelessClient.java
+++ b/src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToStatelessClient.java
@@ -2,7 +2,8 @@ package org.openslx.virtualization.configuration.data;
 
 /**
  * Data container to collect and store input arguments for a
- * {@link ConfigurationLogicDozModServerToStatelessClient} transformation.
+ * {@link org.openslx.virtualization.configuration.logic.ConfigurationLogicDozModServerToStatelessClient}
+ * transformation.
  * 
  * @author Manuel Bentele
  * @version 1.0
@@ -27,7 +28,8 @@ public class ConfigurationDataDozModServerToStatelessClient
 
 	/**
 	 * Creates a new data container to collect and store input arguments for a
-	 * {@link ConfigurationLogicDozModServerToStatelessClient} transformation.
+	 * {@link org.openslx.virtualization.configuration.logic.ConfigurationLogicDozModServerToStatelessClient}
+	 * transformation.
 	 * 
 	 * @param displayName display name for a transformation of a virtualization configuration.
 	 * @param osId operating system identifier for a transformation of a virtualization
diff --git a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModClientToDozModServer.java b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModClientToDozModServer.java
index d64f42a..f375693 100644
--- a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModClientToDozModServer.java
+++ b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModClientToDozModServer.java
@@ -14,7 +14,7 @@ import org.openslx.virtualization.configuration.transformation.TransformationExc
  * 
  * <pre>
  *   +------------------------------+  DozModClientToDozModServer   +------------------------------+
- *   | virtualization configuration | ----------------------------> | virtualization configuration |
+ *   | virtualization configuration | ----------------------------▶ | virtualization configuration |
  *   +---------------+--------------+     transformation logic      +---------------+--------------+
  *   | dozmod-client |                                              | dozmod-server |
  *   +---------------+                                              +---------------+
diff --git a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToDozModClient.java b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToDozModClient.java
index 05b3d4a..06c8ad1 100644
--- a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToDozModClient.java
+++ b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToDozModClient.java
@@ -18,7 +18,7 @@ import org.openslx.virtualization.configuration.transformation.TransformationExc
  * 
  * <pre>
  *   +------------------------------+  DozModServerToDozModClient   +------------------------------+
- *   | virtualization configuration | ----------------------------> | virtualization configuration |
+ *   | virtualization configuration | ----------------------------▶ | virtualization configuration |
  *   +---------------+--------------+     transformation logic      +---------------+--------------+
  *   | dozmod-server |                                              | dozmod-client |
  *   +---------------+                                              +---------------+
diff --git a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToStatelessClient.java b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToStatelessClient.java
index 580b0fc..30d690a 100644
--- a/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToStatelessClient.java
+++ b/src/main/java/org/openslx/virtualization/configuration/logic/ConfigurationLogicDozModServerToStatelessClient.java
@@ -16,7 +16,7 @@ import org.openslx.virtualization.configuration.transformation.TransformationExc
  * 
  * <pre>
  *   +------------------------------+  DozModServerToStatelessClient   +------------------------------+
- *   | virtualization configuration | -------------------------------> | virtualization configuration |
+ *   | virtualization configuration | -------------------------------▶ | virtualization configuration |
  *   +---------------+--------------+      transformation logic        +------------------+-----------+
  *   | dozmod-server |                                                 | stateless client |
  *   +---------------+                                                 +------------------+
diff --git a/src/main/java/org/openslx/virtualization/configuration/transformation/TransformationSpecific.java b/src/main/java/org/openslx/virtualization/configuration/transformation/TransformationSpecific.java
index 5b13f45..7038abf 100644
--- a/src/main/java/org/openslx/virtualization/configuration/transformation/TransformationSpecific.java
+++ b/src/main/java/org/openslx/virtualization/configuration/transformation/TransformationSpecific.java
@@ -23,6 +23,7 @@ public abstract class TransformationSpecific<T, R, H> extends Transformation<T,
 	 * Create a specific transformation.
 	 * 
 	 * @param name comprehensible name for the transformation.
+	 * @param virtualizer initialized virtualizer.
 	 */
 	public TransformationSpecific( String name, H virtualizer )
 	{
diff --git a/src/main/java/org/openslx/vm/disk/DiskImage.java b/src/main/java/org/openslx/vm/disk/DiskImage.java
index 309ad77..d2cd71b 100644
--- a/src/main/java/org/openslx/vm/disk/DiskImage.java
+++ b/src/main/java/org/openslx/vm/disk/DiskImage.java
@@ -194,7 +194,7 @@ public abstract class DiskImage
 		/**
 		 * Checks if the disk image format is supported by a virtualizer.
 		 * 
-		 * @param supportedImageTypes list of supported disk image formats of a virtualizer.
+		 * @param supportedImageFormats list of supported disk image formats of a virtualizer.
 		 * @return <code>true</code> if image type is supported by the virtualizer; otherwise
 		 *         <code>false</code>.
 		 */
diff --git a/src/main/java/org/openslx/vm/disk/DiskImageQcow2.java b/src/main/java/org/openslx/vm/disk/DiskImageQcow2.java
index 04e61ea..657c144 100644
--- a/src/main/java/org/openslx/vm/disk/DiskImageQcow2.java
+++ b/src/main/java/org/openslx/vm/disk/DiskImageQcow2.java
@@ -51,7 +51,7 @@ public class DiskImageQcow2 extends DiskImage
 	/**
 	 * Creates a new QCOW2 disk image from an existing QCOW2 image file.
 	 * 
-	 * @param diskImage file to a QCOW2 disk storing the image content.
+	 * @param disk file to a QCOW2 disk storing the image content.
 	 * 
 	 * @throws FileNotFoundException cannot find specified QCOW2 disk image file.
 	 * @throws IOException cannot access the content of the QCOW2 disk image file.
@@ -64,7 +64,7 @@ public class DiskImageQcow2 extends DiskImage
 	/**
 	 * Creates a new QCOW2 disk image from an existing QCOW2 image file.
 	 * 
-	 * @param diskImage file to a QCOW2 disk storing the image content.
+	 * @param disk file to a QCOW2 disk storing the image content.
 	 */
 	public DiskImageQcow2( RandomAccessFile disk )
 	{
diff --git a/src/main/java/org/openslx/vm/disk/DiskImageUtils.java b/src/main/java/org/openslx/vm/disk/DiskImageUtils.java
index cc29721..ccb053f 100644
--- a/src/main/java/org/openslx/vm/disk/DiskImageUtils.java
+++ b/src/main/java/org/openslx/vm/disk/DiskImageUtils.java
@@ -114,12 +114,12 @@ public class DiskImageUtils
 	}
 
 	/**
-	 * Reads two bytes ({@link Short}) at a given <code>offset</code> from the specified disk image
-	 * file.
+	 * Reads a variable number of bytes (<code>numBytes</code>) at a given <code>offset</code> from the specified disk image file.
 	 * 
 	 * @param diskImage file to a disk storing the image content.
-	 * @param offset offset in bytes for reading the two bytes.
-	 * @return value of the two bytes from the disk image file as {@link Short}.
+	 * @param offset offset in bytes for reading <code>numBytes</code> bytes.
+	 * @param numBytes number of bytes to read at <code>offset</code>.
+	 * @return read bytes from the disk image file as {@link String}.
 	 * 
 	 * @throws DiskImageException unable to read two bytes from the disk image file.
 	 */
diff --git a/src/main/java/org/openslx/vm/disk/DiskImageVmdk.java b/src/main/java/org/openslx/vm/disk/DiskImageVmdk.java
index 7f59bc3..b2f45a1 100644
--- a/src/main/java/org/openslx/vm/disk/DiskImageVmdk.java
+++ b/src/main/java/org/openslx/vm/disk/DiskImageVmdk.java
@@ -183,7 +183,8 @@ public class DiskImageVmdk extends DiskImage
 	 * 
 	 * @return hardware version from the VMDK's embedded descriptor file.
 	 * 
-	 * @throws DiskImageException
+	 * @throws DiskImageException unable to obtain the VMDK's hardware version of the disk image
+	 *            format.
 	 */
 	public Version getHwVersion() throws DiskImageException
 	{
-- 
cgit v1.2.3-55-g7522