diff options
Diffstat (limited to 'src/main/java/org/openslx/virtualization')
11 files changed, 31 insertions, 16 deletions
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 ) { |