fix linter issues

Signed-off-by: Jalander Ramagiri <jalander.ramagiri@est.tech>
cdevents · Jul 4, 2024 · 67d2b79 · 67d2b79
1 parent aab785a
commit 67d2b79
Show file tree

Hide file tree

Showing 48 changed files with 62 additions and 54 deletions.
diff --git a/generator/src/main/resources/template/event-template.mustache b/generator/src/main/resources/template/event-template.mustache
@@ -117,7 +117,7 @@ public class {{capitalizedSubject}}{{capitalizedPredicate}}CDEvent extends {{cap
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/CDEvents.java b/sdk/src/main/java/dev/cdevents/CDEvents.java
@@ -91,8 +91,8 @@ public static boolean validateCDEvent(CDEvent cdEvent) {
 
     /**
      * Creates cdEvent from cdEventJson string and validates against schema.
-     * @param cdEventJson
-     * @return CDEvent, needs type casting to specific CDEvent class
+     * @param cdEventJson json string of any CDEvent type
+     * @return CDEvent needs type casting to specific CDEvent class
      */
     public static CDEvent cdEventFromJson(String cdEventJson) {
         String eventType = getUnVersionedEventTypeFromJson(cdEventJson);
@@ -110,8 +110,9 @@ public static CDEvent cdEventFromJson(String cdEventJson) {
     }
 
     /**
-     * Creates a CloudEvent from the custom cdEvent
-     * @param customCDEvent
+     * Creates a CloudEvent from the custom cdEvent.
+     * @param customCDEvent custom CDEvent class object
+     * @param validateContextSchema true If validation needed against context.schemaUri
      * @return CloudEvent
      */
     public static <T extends CDEvent> CloudEvent customCDEventAsCloudEvent(T customCDEvent, boolean validateContextSchema) {
@@ -127,6 +128,13 @@ public static <T extends CDEvent> CloudEvent customCDEventAsCloudEvent(T customC
         }
     }
 
+    /**
+     * Creates customCDEvent from Json string and validates against context and official schemas.
+     * @param customCDEventJson Json string of customCDEvent class type <T>
+     * @param eventClass customCDEvent class type <T>
+     * @param validateContextSchema true If validation needed against context.schemaUri
+     * @return CDEvent
+     */
     public static <T extends CDEvent> T customCDEventFromJson(String customCDEventJson, Class<T> eventClass, boolean validateContextSchema) {
         try {
             T cdEvent = new ObjectMapper().readValue(customCDEventJson, eventClass);
@@ -141,8 +149,8 @@ public static <T extends CDEvent> T customCDEventFromJson(String customCDEventJs
 
     /**
      * Validates the custom CDEvent against the official and context schemas.
-     * @param customCDEvent, custom CDEvent to validate
-     * @param validateContextSchema, true to validate custom CDEvent against context schema
+     * @param customCDEvent custom CDEvent to validate
+     * @param validateContextSchema true to validate custom CDEvent against context schema
      * @return valid cdEvent
      */
     public static boolean validateCustomCDEvent(CDEvent customCDEvent, boolean validateContextSchema) {
@@ -155,7 +163,7 @@ public static boolean validateCustomCDEvent(CDEvent customCDEvent, boolean valid
 
     /**
      * Validates the custom CDEvent against the provided context Schema URI.
-     * @param customCDEvent, custom CDEvent to validate
+     * @param customCDEvent custom CDEvent to validate
      * @return valid cdEvent
      */
     public static boolean validateWithContextSchemaUri(CDEvent customCDEvent) {

diff --git a/sdk/src/main/java/dev/cdevents/events/ArtifactDeletedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ArtifactDeletedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ArtifactDownloadedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ArtifactDownloadedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ArtifactPackagedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ArtifactPackagedCDEvent.java
@@ -116,7 +116,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ArtifactPublishedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ArtifactPublishedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ArtifactSignedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ArtifactSignedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/BranchCreatedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/BranchCreatedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/BranchDeletedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/BranchDeletedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/BuildFinishedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/BuildFinishedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/BuildQueuedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/BuildQueuedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/BuildStartedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/BuildStartedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ChangeAbandonedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ChangeAbandonedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ChangeCreatedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ChangeCreatedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ChangeMergedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ChangeMergedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ChangeReviewedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ChangeReviewedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ChangeUpdatedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ChangeUpdatedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/EnvironmentCreatedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/EnvironmentCreatedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/EnvironmentDeletedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/EnvironmentDeletedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/EnvironmentModifiedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/EnvironmentModifiedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/IncidentDetectedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/IncidentDetectedCDEvent.java
@@ -116,7 +116,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/IncidentReportedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/IncidentReportedCDEvent.java
@@ -116,7 +116,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/IncidentResolvedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/IncidentResolvedCDEvent.java
@@ -116,7 +116,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/PipelinerunFinishedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/PipelinerunFinishedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/PipelinerunQueuedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/PipelinerunQueuedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/PipelinerunStartedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/PipelinerunStartedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/RepositoryCreatedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/RepositoryCreatedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/RepositoryDeletedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/RepositoryDeletedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/RepositoryModifiedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/RepositoryModifiedCDEvent.java
@@ -114,7 +114,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ServiceDeployedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ServiceDeployedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ServicePublishedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ServicePublishedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ServiceRemovedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ServiceRemovedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ServiceRolledbackCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ServiceRolledbackCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/ServiceUpgradedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/ServiceUpgradedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/TaskrunFinishedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/TaskrunFinishedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/TaskrunStartedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/TaskrunStartedCDEvent.java
@@ -115,7 +115,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/TestcaserunFinishedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/TestcaserunFinishedCDEvent.java
@@ -117,7 +117,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/TestcaserunQueuedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/TestcaserunQueuedCDEvent.java
@@ -118,7 +118,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }
 

diff --git a/sdk/src/main/java/dev/cdevents/events/TestcaserunSkippedCDEvent.java b/sdk/src/main/java/dev/cdevents/events/TestcaserunSkippedCDEvent.java
@@ -117,7 +117,7 @@ public String schemaFileName() {
     * @return custom schema URI
     */
     @Override
-    public URI customSchemaUri(){
+    public URI customSchemaUri() {
         return getContext().getSchemaUri();
     }