From 205216f7dda581a6d3ef1788e74592bc8c07c28b Mon Sep 17 00:00:00 2001 From: Jonathan Philip Knoblauch Date: Fri, 6 May 2016 16:08:16 +0200 Subject: [PATCH] Added @SuppressWarnings annotation and reseted readme.md in hawkbit parent Signed-off-by: Jonathan Philip Knoblauch --- README.md | 43 ++++++------------- .../java/org/eclipse/hawkbit/app/Start.java | 2 + .../builder/DistributionSetBuilder.java | 2 + .../builder/DistributionSetTypeBuilder.java | 2 + .../resource/builder/RolloutBuilder.java | 2 + .../SoftwareModuleAssigmentBuilder.java | 2 + .../builder/SoftwareModuleBuilder.java | 2 + .../builder/SoftwareModuleTypeBuilder.java | 15 ++++--- .../client/resource/builder/TagBuilder.java | 12 +++--- .../resource/builder/TargetBuilder.java | 12 +++--- 10 files changed, 49 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index a6928b3f2..e61e5e9d1 100644 --- a/README.md +++ b/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 - -* `examples` : hawkBit examples -* `hawkbit-artifact-repository-mongo` : Artifact repository implementation to mongoDB. -* `hawkbit-autoconfigure` : Spring-boot auto-configuration. -* `hawkbit-cache-redis` : Spring cache manager configuration and implementation with redis, distributed cache and distributed events. -* `hawkbit-core` : Core elements. -* `hawkbit-ddi-api` : The hawkBit DDI API. -* `hawkbit-ddi-dl-api` : The hawkBit DDI Download API. -* `hawkbit-ddi-resource` : Implementation of the hawkBit DDI API -* `hawkbit-dmf-amqp` : AMQP endpoint implementation for the DMF API. -* `hawkbit-dmf-api` : API for the Device Management Integration. -* `hawkbit-http-security` : Implementation for security filters for HTTP. -* `hawkbit-mgmt-api` : The hawkBit Management API -* `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 - - - - - - +`hawkbit-core` : internal interfaces and utility classes.. +`hawkbit-security-core` : authentication and authorization. +`hawkbit-security-integration` : authentication and authorization integrated with the APIs. +`hawkbit-artifact-repository-mongo` : artifact repository implementation to MongoDB. +`hawkbit-autoconfigure` : spring-boot auto-configuration. +`hawkbit-dmf-api` : API for the Device Management Integration. +`hawkbit-dmf-amqp` : AMQP endpoint implementation for the DMF API. +`hawkbit-repository` : repository implementation based on SQL for all meta-data. +`hawkbit-http-security` : implementation for security filters for HTTP. +`hawkbit-rest-api` : API classes for the REST Management API. +`hawkbit-rest-resource` : HTTP REST endpoints for the Management and the Direct Device API. +`hawkbit-ui` : Vaadin UI. +`hawkbit-cache-redis` : spring cache manager configuration and implementation with redis, distributed cache and distributed events. diff --git a/examples/hawkbit-example-app/src/main/java/org/eclipse/hawkbit/app/Start.java b/examples/hawkbit-example-app/src/main/java/org/eclipse/hawkbit/app/Start.java index a8f2bc645..7a8e0814d 100644 --- a/examples/hawkbit-example-app/src/main/java/org/eclipse/hawkbit/app/Start.java +++ b/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 { /** diff --git a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/DistributionSetBuilder.java b/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/DistributionSetBuilder.java index d1b3fad35..1e58b8415 100644 --- a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/DistributionSetBuilder.java +++ b/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; diff --git a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/DistributionSetTypeBuilder.java b/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/DistributionSetTypeBuilder.java index e08240de3..1ce2ff270 100644 --- a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/DistributionSetTypeBuilder.java +++ b/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; diff --git a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/RolloutBuilder.java b/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/RolloutBuilder.java index 9ba378192..02ebe2de3 100644 --- a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/RolloutBuilder.java +++ b/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; diff --git a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/SoftwareModuleAssigmentBuilder.java b/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/SoftwareModuleAssigmentBuilder.java index a6003e2c5..b9fbcb498 100644 --- a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/SoftwareModuleAssigmentBuilder.java +++ b/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 ids; diff --git a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/SoftwareModuleBuilder.java b/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/SoftwareModuleBuilder.java index 6f243d08a..b2e544f88 100644 --- a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/SoftwareModuleBuilder.java +++ b/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; diff --git a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/SoftwareModuleTypeBuilder.java b/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/SoftwareModuleTypeBuilder.java index 749546442..7981e61cf 100644 --- a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/SoftwareModuleTypeBuilder.java +++ b/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 - * the RESTful-API. + * {@link MgmtSoftwareModuleTypeRequestBodyPost} which can directly be used + * in the RESTful-API. * - * @return a single entry list of {@link MgmtSoftwareModuleTypeRequestBodyPost} + * @return a single entry list of + * {@link MgmtSoftwareModuleTypeRequestBodyPost} */ public List build() { return Lists.newArrayList(doBuild(key, name)); } /** - * Builds a list of multiple {@link MgmtSoftwareModuleTypeRequestBodyPost} to - * create multiple software module types at once. An increasing number will - * be added to the name and key of the software module type. + * Builds a list of multiple {@link MgmtSoftwareModuleTypeRequestBodyPost} + * to create multiple software module types at once. An increasing number + * 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 diff --git a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/TagBuilder.java b/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/TagBuilder.java index 6718e631e..ce13602df 100644 --- a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/TagBuilder.java +++ b/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 - * directly be used in the RESTful-API. + * Builds a list with a single entry of {@link MgmtTagRequestBodyPut} which + * 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 - * tags at once. An increasing number will be added to the name of the tag. - * The color and description will remain the same. + * Builds a list of multiple {@link MgmtTagRequestBodyPut} to create + * multiple tags at once. An increasing number will be added to the name of + * the tag. The color and description will remain the same. * * @param count * the amount of distribution sets body which should be created diff --git a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/TargetBuilder.java b/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/TargetBuilder.java index 09b20339b..7bcc0af09 100644 --- a/examples/hawkbit-example-mgmt-client/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/TargetBuilder.java +++ b/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 - * directly be used in the RESTful-API. + * Builds a list with a single entry of {@link MgmtTargetRequestBody} which + * 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 - * targets at once. An increasing number will be added to the controllerId - * of the target. The name and description will remain. + * Builds a list of multiple {@link MgmtTargetRequestBody} to create + * multiple targets at once. An increasing number will be added to the + * controllerId of the target. The name and description will remain. * * @param count * the amount of software module type bodies which should be