Fix checkstyle warnings and formatting

Add Javadoc and make cosmetic changes to prevent Checkstyle messages

Change-Id: Ibab7be42d6a01b181cdb625b6b34d580658c7046
Issue-ID: AAI-2212
Signed-off-by: mark.j.leonard <mark.j.leonard@gmail.com>

3 files changed, 38 insertions, 15 deletions

diff --git a/src/test/java/org/onap/aai/babel/parser/TestArtifactGeneratorToscaParser.java b/src/test/java/org/onap/aai/babel/parser/TestArtifactGeneratorToscaParser.java
index 4451a28..2de10b9 100644
--- a/src/test/java/org/onap/aai/babel/parser/TestArtifactGeneratorToscaParser.java
+++ b/src/test/java/org/onap/aai/babel/parser/TestArtifactGeneratorToscaParser.java
@@ -57,6 +57,7 @@ public class TestArtifactGeneratorToscaParser {
      * Initialize the Generator with an invalid artifact generator properties file path.
      * 
      * @throws IOException
+     *             if an error occurs reading the configuration properties
      */
     @Test(expected = IllegalArgumentException.class)
     public void testMissingPropertiesFile() throws IOException {
@@ -68,6 +69,7 @@ public class TestArtifactGeneratorToscaParser {
      * Initialize the Generator with an invalid mappings file path.
      * 
      * @throws IOException
+     *             if the file content could not be read successfully
      */
     @Test(expected = IllegalArgumentException.class)
     public void testMissingMappingsFile() throws IOException {
@@ -78,6 +80,7 @@ public class TestArtifactGeneratorToscaParser {
      * Initialize the Generator with no Widget Mappings content.
      * 
      * @throws IOException
+     *             if the file content could not be read successfully
      */
     @Test(expected = IOException.class)
     public void testMissingMappingsContent() throws IOException {
@@ -89,6 +92,7 @@ public class TestArtifactGeneratorToscaParser {
      * Initialize the Generator with invalid Widget Mappings content.
      * 
      * @throws IOException
+     *             if the file content could not be read successfully
      */
     @Test(expected = IOException.class)
     public void testInvalidMappingsContent() throws IOException {
@@ -118,7 +122,7 @@ public class TestArtifactGeneratorToscaParser {
     }
 
     /**
-     * Initialise the Artifact Generator Widget Mapping config with incomplete data.
+     * Initialise the Artifact Generator Widget Mapping config with incomplete data (no type).
      */
     @Test(expected = IllegalArgumentException.class)
     public void testToscaMappingWithoutType() {
@@ -128,7 +132,7 @@ public class TestArtifactGeneratorToscaParser {
     }
 
     /**
-     * Initialise the Artifact Generator Widget Mapping config with incomplete data.
+     * Initialise the Artifact Generator Widget Mapping config with incomplete data (no widget name).
      */
     @Test(expected = IllegalArgumentException.class)
     public void testToscaMappingWithoutWidget() {
@@ -141,6 +145,7 @@ public class TestArtifactGeneratorToscaParser {
      * Process a dummy Group object for a Service Resource.
      * 
      * @throws XmlArtifactGenerationException
+     *             if there is no configuration defined for a member Widget of an instance group
      */
     @Test
     public void testInstanceGroups() throws XmlArtifactGenerationException {
diff --git a/src/test/java/org/onap/aai/babel/xml/generator/model/TestVfModule.java b/src/test/java/org/onap/aai/babel/xml/generator/model/TestVfModule.java
index 4171023..cc6d968 100644
--- a/src/test/java/org/onap/aai/babel/xml/generator/model/TestVfModule.java
+++ b/src/test/java/org/onap/aai/babel/xml/generator/model/TestVfModule.java
@@ -46,6 +46,8 @@ public class TestVfModule {
     }
 
     /**
+     * Initialize the Widget mappings.
+     * 
      * @throws IOException
      *             if a properties file is not loaded
      */
@@ -99,7 +101,9 @@ public class TestVfModule {
     /**
      * Add a new Widget to a VF Module, where the Widget is NOT set as a member. N.B. For the current VF Module
      * implementation the actual Widget type is not important.
-     * @throws XmlArtifactGenerationException 
+     * 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     @Test
     public void testNonMemberWidgetToVf() throws XmlArtifactGenerationException {
@@ -110,7 +114,9 @@ public class TestVfModule {
 
     /**
      * OAM Network is specifically excluded from a VF Module.
-     * @throws XmlArtifactGenerationException 
+     * 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     @Test
     public void testAddOamNetworkWidgetToVf() throws XmlArtifactGenerationException {
@@ -126,7 +132,9 @@ public class TestVfModule {
      * <li>Add a Volume Widget</li>
      * <li>Add a vserver Widget</li>
      * <li>Check that the Volume Widget appears under the vserver</li>
-     * @throws XmlArtifactGenerationException 
+     * 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     @Test
     public void testAddVolumeWidgetToVf() throws XmlArtifactGenerationException {
@@ -159,7 +167,9 @@ public class TestVfModule {
      * <li>Add an L-Interface Widget</li>
      * <li>Add a vserver Widget</li>
      * <li>Check that the L-Interface Widget appears under the vserver</li>
-     * @throws XmlArtifactGenerationException 
+     * 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     @Test
     public void testAddLinterfaceWidgetToVf() throws XmlArtifactGenerationException {
@@ -193,7 +203,9 @@ public class TestVfModule {
      * <li>Add an L-Interface Widget</li>
      * <li>Add a vserver Widget</li>
      * <li>Check that both Widgets appear under the vserver</li>
-     * @throws XmlArtifactGenerationException 
+     * 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     @Test
     public void testAddVolumeAndLinterfaceWidgetToVf() throws XmlArtifactGenerationException {
@@ -234,7 +246,8 @@ public class TestVfModule {
      * @param widgetType
      *            type of Widget to create
      * @return a new Widget
-     * @throws XmlArtifactGenerationException 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     private Widget createNewWidget(Type widgetType) throws XmlArtifactGenerationException {
         return Widget.getWidget(widgetType);
@@ -270,7 +283,8 @@ public class TestVfModule {
      *            the VF Module to update
      * @param widgetType
      *            the type of Widget to create and add
-     * @throws XmlArtifactGenerationException 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     private void assertAddWidget(Resource vfModule, Type widgetType) throws XmlArtifactGenerationException {
         assertThat(createNewWidgetForModule(vfModule, widgetType), is(true));
@@ -283,7 +297,8 @@ public class TestVfModule {
      *            the VF Module
      * @param widgetType
      *            the type of Widget to create and attempt to add
-     * @throws XmlArtifactGenerationException 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     private void assertFailToAddWidget(Resource vfModule, Type widgetType) throws XmlArtifactGenerationException {
         assertThat(createNewWidgetForModule(vfModule, widgetType), is(false));
@@ -297,7 +312,8 @@ public class TestVfModule {
      * @param widgetType
      *            the type of Widget to create and attempt to add
      * @return whether or not the Widget was added to the module
-     * @throws XmlArtifactGenerationException 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     private boolean createNewWidgetForModule(Resource vfModule, Type widgetType) throws XmlArtifactGenerationException {
         Widget widget = createNewWidget(widgetType);
@@ -327,7 +343,8 @@ public class TestVfModule {
      * @param vfModule
      *            the VF Module to update
      * @return the number of Widgets present in the vserver on creation
-     * @throws XmlArtifactGenerationException 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     private int createVserverForVf(Resource vfModule) throws XmlArtifactGenerationException {
         Widget vserverWidget = createNewWidget(Type.VSERVER);
@@ -345,7 +362,8 @@ public class TestVfModule {
      * @param vserverWidget
      *            the Widget to add
      * @return initial widget count for the vserver Widget
-     * @throws XmlArtifactGenerationException 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     private int addVserverToVf(Resource vfModule, Widget vserverWidget) throws XmlArtifactGenerationException {
         // A vserver (initially) has Flavor, Image, Tenant and Vfc.
diff --git a/src/test/java/org/onap/aai/babel/xml/generator/model/TestWidget.java b/src/test/java/org/onap/aai/babel/xml/generator/model/TestWidget.java
index da6e4d5..00694b2 100644
--- a/src/test/java/org/onap/aai/babel/xml/generator/model/TestWidget.java
+++ b/src/test/java/org/onap/aai/babel/xml/generator/model/TestWidget.java
@@ -34,7 +34,7 @@ import org.onap.aai.babel.xml.generator.model.Widget.Type;
 import org.onap.aai.babel.xml.generator.types.ModelType;
 
 /**
- * Direct tests of the Widget class for code coverage.  
+ * Direct tests of the Widget class for code coverage.
  */
 public class TestWidget {
 
@@ -61,7 +61,7 @@ public class TestWidget {
         assertThat(widget.getType(), is(ModelType.WIDGET));
         assertThat(widget.getName(), is("service-instance"));
         assertThat(widget.getDeleteFlag(), is(true));
-        
+
         widget = Widget.getWidget(Type.VF);
         assertThat(widget.getType(), is(ModelType.WIDGET));
         assertThat(widget.getName(), is("generic-vnf"));