diff options
author | Manuel Bentele | 2021-04-28 09:19:42 +0200 |
---|---|---|
committer | Manuel Bentele | 2021-04-28 09:19:42 +0200 |
commit | 46b8f8b5f69efebb0ae389cff6627d70f7633fc2 (patch) | |
tree | e33f4a239408f9e4e12c730cf2b7642414330fad /src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java | |
parent | Log failed instanciations of virtualization config files as debug info (diff) | |
download | master-sync-shared-46b8f8b5f69efebb0ae389cff6627d70f7633fc2.tar.gz master-sync-shared-46b8f8b5f69efebb0ae389cff6627d70f7633fc2.tar.xz master-sync-shared-46b8f8b5f69efebb0ae389cff6627d70f7633fc2.zip |
Document configuration transformation logics and their data containers
Diffstat (limited to 'src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java')
-rw-r--r-- | src/main/java/org/openslx/virtualization/configuration/data/ConfigurationDataDozModServerToDozModClient.java | 65 |
1 files changed, 65 insertions, 0 deletions
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; |