Document configuration transformation logics and their data containers

3 files changed, 123 insertions, 0 deletions

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;