Added @SuppressWarnings annotation and reseted readme.md in hawkbit parent

Signed-off-by: Jonathan Philip Knoblauch <JonathanPhilip.Knoblauch@bosch-si.com>

README.md

@@ -52,36 +52,21 @@ $ java -jar ./examples/hawkbit-mgmt-api-client/target/hawkbit-mgmt-api-client-#v
 * The master branch contains future development towards 0.2. We are currently focusing on:
   * Rollout Management for large scale rollouts.
   * Clustering capabilities for the update server.
-  * Upgrade of Spring Boot and Vaadin depedencies.
+  * Upgrade of Spring Boot and Vaadin dependencies.
   * And of course tons of usability improvements and bug fixes.
 
 
 # Modules
-
+`hawkbit-core` : internal interfaces and utility classes..  
-* `examples` : hawkBit examples 
+`hawkbit-security-core` : authentication and authorization.  
-* `hawkbit-artifact-repository-mongo` : Artifact repository implementation to mongoDB. 
+`hawkbit-security-integration` : authentication and authorization integrated with the APIs.  
-* `hawkbit-autoconfigure` : Spring-boot auto-configuration. 
+`hawkbit-artifact-repository-mongo` : artifact repository implementation to MongoDB.    
-* `hawkbit-cache-redis` : Spring cache manager configuration and implementation with redis, distributed cache and distributed events.
+`hawkbit-autoconfigure` : spring-boot auto-configuration.  
-* `hawkbit-core` : Core elements.  
+`hawkbit-dmf-api` : API for the Device Management Integration.  
-* `hawkbit-ddi-api` : The hawkBit DDI API.
+`hawkbit-dmf-amqp` : AMQP endpoint implementation for the DMF API.  
-* `hawkbit-ddi-dl-api` : The hawkBit DDI Download API.
+`hawkbit-repository` : repository implementation based on SQL for all meta-data.    
-* `hawkbit-ddi-resource` : Implementation of the hawkBit DDI API
+`hawkbit-http-security` : implementation for security filters for HTTP.    
-* `hawkbit-dmf-amqp` : AMQP endpoint implementation for the DMF API. 
+`hawkbit-rest-api` : API classes for the REST Management API.  
-* `hawkbit-dmf-api` : API for the Device Management Integration.  
+`hawkbit-rest-resource` : HTTP REST endpoints for the Management and the Direct Device API.  
-* `hawkbit-http-security` : Implementation for security filters for HTTP.  
+`hawkbit-ui` : Vaadin UI.  
-* `hawkbit-mgmt-api` : The hawkBit Management API
+`hawkbit-cache-redis` : spring cache manager configuration and implementation with redis, distributed cache and distributed events.
-* `hawkbit-mgmt-resource` : Implementation of the hawkBit Management API
-* `hawkbit-mgmt-ui` : Vaadin UI.  
-* `hawkbit-repository` : Repository implementation based on SQL for all meta-data.   
-* `hawkbit-rest-core` : Core elements for the rest modules.
-* `hawkbit-security-core` : Core security elements.  
-* `hawkbit-security-integration` : Security integration elements to integrate security into hawkBit.  
-* `hawkbit-system-api` : The hawkBit System API
-* `hawkbit-system-resource` : Implementation of the hawkBit System API
-* `hawkbit-test-report` : Test reports
-
- 
-
-
-
-

examples/hawkbit-example-app/src/main/java/org/eclipse/hawkbit/app/Start.java

@@ -28,6 +28,8 @@ import org.springframework.context.annotation.Import;
 @EnableMgmtApi
 @EnableDdiApi
 @EnableSystemApi
+// Exception squid:S1118 - Spring boot standard behavior
+@SuppressWarnings({ "squid:S1118" })
 public class Start {
 
     /**

examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/DistributionSetBuilder.java

@@ -19,6 +19,8 @@ import com.google.common.collect.Lists;
 /**
  * Builder pattern for building {@link MgmtDistributionSetRequestBodyPost}.
  */
+// Exception squid:S1701 - builder pattern
+@SuppressWarnings({ "squid:S1701" })
 public class DistributionSetBuilder {
 
     private String name;

examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/DistributionSetTypeBuilder.java

@@ -21,6 +21,8 @@ import com.google.common.collect.Lists;
  * Builder pattern for building {@link MgmtDistributionSetTypeRequestBodyPost}.
  *
  */
+// Exception squid:S1701 - builder pattern
+@SuppressWarnings({ "squid:S1701" })
 public class DistributionSetTypeBuilder {
 
     private String key;

examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/RolloutBuilder.java

@@ -17,6 +17,8 @@ import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutRestRequestBody;
  * Builder pattern for building {@link MgmtRolloutRestRequestBody}.
  *
  */
+// Exception squid:S1701 - builder pattern
+@SuppressWarnings({ "squid:S1701" })
 public class RolloutBuilder {
 
     private String name;

examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/SoftwareModuleAssigmentBuilder.java

@@ -18,6 +18,8 @@ import org.eclipse.hawkbit.mgmt.json.model.softwaremodule.MgmtSoftwareModuleAssi
  * Builder pattern for building {@link MgmtSoftwareModuleAssigment}.
  *
  */
+// Exception squid:S1701 - builder pattern
+@SuppressWarnings({ "squid:S1701" })
 public class SoftwareModuleAssigmentBuilder {
 
     private final List<Long> ids;

examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/SoftwareModuleBuilder.java

@@ -21,6 +21,8 @@ import com.google.common.collect.Lists;
  * Builder pattern for building {@link MgmtSoftwareModuleRequestBodyPost}.
  *
  */
+// Exception squid:S1701 - builder pattern
+@SuppressWarnings({ "squid:S1701" })
 public class SoftwareModuleBuilder {
 
     private String name;

examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/SoftwareModuleTypeBuilder.java

@@ -21,6 +21,8 @@ import com.google.common.collect.Lists;
  * Builder pattern for building {@link MgmtSoftwareModuleRequestBodyPost}.
  *
  */
+// Exception squid:S1701 - builder pattern
+@SuppressWarnings({ "squid:S1701" })
 public class SoftwareModuleTypeBuilder {
 
     private String key;
@@ -60,19 +62,20 @@ public class SoftwareModuleTypeBuilder {
 
     /**
      * Builds a list with a single entry of
-     * {@link MgmtSoftwareModuleTypeRequestBodyPost} which can directly be used in
+     * {@link MgmtSoftwareModuleTypeRequestBodyPost} which can directly be used
-     * the RESTful-API.
+     * in the RESTful-API.
      * 
-     * @return a single entry list of {@link MgmtSoftwareModuleTypeRequestBodyPost}
+     * @return a single entry list of
+     *         {@link MgmtSoftwareModuleTypeRequestBodyPost}
      */
     public List<MgmtSoftwareModuleTypeRequestBodyPost> build() {
         return Lists.newArrayList(doBuild(key, name));
     }
 
     /**
-     * Builds a list of multiple {@link MgmtSoftwareModuleTypeRequestBodyPost} to
+     * Builds a list of multiple {@link MgmtSoftwareModuleTypeRequestBodyPost}
-     * create multiple software module types at once. An increasing number will
+     * to create multiple software module types at once. An increasing number
-     * be added to the name and key of the software module type.
+     * will be added to the name and key of the software module type.
      * 
      * @param count
      *            the amount of software module type bodies which should be

examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/TagBuilder.java

@@ -19,6 +19,8 @@ import com.google.common.collect.Lists;
  * Builder pattern for building {@link MgmtTagRequestBodyPut}.
  *
  */
+// Exception squid:S1701 - builder pattern
+@SuppressWarnings({ "squid:S1701" })
 public class TagBuilder {
 
     private String name;
@@ -56,8 +58,8 @@ public class TagBuilder {
     }
 
     /**
-     * Builds a list with a single entry of {@link MgmtTagRequestBodyPut} which can
+     * Builds a list with a single entry of {@link MgmtTagRequestBodyPut} which
-     * directly be used in the RESTful-API.
+     * can directly be used in the RESTful-API.
      * 
      * @return a single entry list of {@link MgmtTagRequestBodyPut}
      */
@@ -66,9 +68,9 @@ public class TagBuilder {
     }
 
     /**
-     * Builds a list of multiple {@link MgmtTagRequestBodyPut} to create multiple
+     * Builds a list of multiple {@link MgmtTagRequestBodyPut} to create
-     * tags at once. An increasing number will be added to the name of the tag.
+     * multiple tags at once. An increasing number will be added to the name of
-     * The color and description will remain the same.
+     * the tag. The color and description will remain the same.
      * 
      * @param count
      *            the amount of distribution sets body which should be created

examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/TargetBuilder.java

@@ -21,6 +21,8 @@ import com.google.common.collect.Lists;
  * Builder pattern for building {@link MgmtTargetRequestBody}.
  *
  */
+// Exception squid:S1701 - builder pattern
+@SuppressWarnings({ "squid:S1701" })
 public class TargetBuilder {
 
     private String controllerId;
@@ -58,8 +60,8 @@ public class TargetBuilder {
     }
 
     /**
-     * Builds a list with a single entry of {@link MgmtTargetRequestBody} which can
+     * Builds a list with a single entry of {@link MgmtTargetRequestBody} which
-     * directly be used in the RESTful-API.
+     * can directly be used in the RESTful-API.
      * 
      * @return a single entry list of {@link MgmtTargetRequestBody}
      */
@@ -68,9 +70,9 @@ public class TargetBuilder {
     }
 
     /**
-     * Builds a list of multiple {@link MgmtTargetRequestBody} to create multiple
+     * Builds a list of multiple {@link MgmtTargetRequestBody} to create
-     * targets at once. An increasing number will be added to the controllerId
+     * multiple targets at once. An increasing number will be added to the
-     * of the target. The name and description will remain.
+     * controllerId of the target. The name and description will remain.
      * 
      * @param count
      *            the amount of software module type bodies which should be