fix: adding missing function documentation

eclipse-tractusx · Mar 13, 2024 · 1b54dfc · 1b54dfc
1 parent f9af565
commit 1b54dfc
Show file tree

Hide file tree

Showing 20 changed files with 920 additions and 532 deletions.
diff --git a/src/main/java/org/eclipse/tractusx/ssi/lib/exception/SSIException.class b/src/main/java/org/eclipse/tractusx/ssi/lib/exception/SSIException.class
diff --git a/src/main/java/org/eclipse/tractusx/ssi/lib/exception/SSIException.java b/src/main/java/org/eclipse/tractusx/ssi/lib/exception/SSIException.java
@@ -19,24 +19,51 @@
  * *******************************************************************************
  */
 
-package org.eclipse.tractusx.ssi.lib.exception;
+ package org.eclipse.tractusx.ssi.lib.exception;
 
-public class SSIException extends Exception {
-
-  protected SSIException(String message) {
-    super(message);
-  }
-
-  protected SSIException(String message, Throwable cause) {
-    super(message, cause);
-  }
-
-  protected SSIException(Throwable cause) {
-    super(cause);
-  }
-
-  protected SSIException(
-      String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
-    super(message, cause, enableSuppression, writableStackTrace);
-  }
-}
+ /** The type SSI exception. */
+ public class SSIException extends Exception {
+
+   private static final long serialVersionUID = 1L;
+
+   /**
+    * Instantiates a new SSI exception.
+    *
+    * @param message the message
+    */
+   protected SSIException(String message) {
+     super(message);
+   }
+
+   /**
+    * Instantiates a new SSI exception.
+    *
+    * @param message the message
+    * @param cause the cause
+    */
+   protected SSIException(String message, Throwable cause) {
+     super(message, cause);
+   }
+
+   /**
+    * Instantiates a new SSI exception.
+    *
+    * @param cause the cause
+    */
+   protected SSIException(Throwable cause) {
+     super(cause);
+   }
+
+   /**
+    * Instantiates a new SSI exception.
+    *
+    * @param message the message
+    * @param cause the cause
+    * @param enableSuppression the enable suppression
+    * @param writableStackTrace the writable stack trace
+    */
+   protected SSIException(
+       String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
+     super(message, cause, enableSuppression, writableStackTrace);
+   }
+ }
diff --git a/src/main/java/org/eclipse/tractusx/ssi/lib/exception/did/DidParseException.java b/src/main/java/org/eclipse/tractusx/ssi/lib/exception/did/DidParseException.java
@@ -19,26 +19,49 @@
  * *******************************************************************************
  */
 
-package org.eclipse.tractusx.ssi.lib.exception.did;
+ package org.eclipse.tractusx.ssi.lib.exception.did;
 
-import org.eclipse.tractusx.ssi.lib.exception.SSIException;
-
-public class DidParseException extends SSIException {
-
-  public DidParseException(String did) {
-    super(String.format("Invalid DID URL: %s, not able to parse it", did));
-  }
-
-  public DidParseException(String message, Throwable cause) {
-    super(message, cause);
-  }
-
-  public DidParseException(Throwable cause) {
-    super(cause);
-  }
-
-  public DidParseException(
-      String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
-    super(message, cause, enableSuppression, writableStackTrace);
-  }
-}
+ import org.eclipse.tractusx.ssi.lib.exception.SSIException;
+
+ /** The type Did parse exception. */
+ public class DidParseException extends SSIException {
+
+   private static final long serialVersionUID = 1L;
+   /**
+    * Instantiates a new Did parse exception.
+    *
+    * @param message the message
+    */
+   public DidParseException(String did) {
+     super(String.format("Invalid DID URL: %s, not able to parse it", did));
+   }
+   /**
+    * Instantiates a new Did parse exception.
+    *
+    * @param message the message
+    * @param cause the cause
+    */
+   public DidParseException(String message, Throwable cause) {
+     super(message, cause);
+   }
+   /**
+    * Instantiates a new Did parse exception.
+    *
+    * @param cause the cause
+    */
+   public DidParseException(Throwable cause) {
+     super(cause);
+   }
+   /**
+    * Instantiates a new Did parse exception.
+    *
+    * @param message the message
+    * @param cause the cause
+    * @param enableSuppression the enable suppression
+    * @param writableStackTrace the writable stack trace
+    */
+   public DidParseException(
+       String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
+     super(message, cause, enableSuppression, writableStackTrace);
+   }
+ }
diff --git a/src/main/java/org/eclipse/tractusx/ssi/lib/exception/did/DidResolverException.java b/src/main/java/org/eclipse/tractusx/ssi/lib/exception/did/DidResolverException.java
@@ -19,53 +19,53 @@
  * *******************************************************************************
  */
 
-package org.eclipse.tractusx.ssi.lib.exception.did;
+ package org.eclipse.tractusx.ssi.lib.exception.did;
 
-import org.eclipse.tractusx.ssi.lib.exception.SSIException;
-
-/** The type Did resolver exception. */
-public class DidResolverException extends SSIException {
-
-  private static final long serialVersionUID = 1L;
-  /**
-   * Instantiates a new Did resolver exception.
-   *
-   * @param message the message
-   */
-  public DidResolverException(String message) {
-    super(message);
-  }
-
-  /**
-   * Instantiates a new Did resolver exception from another exception with a message.
-   *
-   * @param message the message
-   * @param cause the cause
-   */
-  public DidResolverException(String message, Throwable cause) {
-    super(message, cause);
-  }
-
-  /**
-   * Instantiates a new Did resolver exception from another exception.
-   *
-   * @param cause the cause
-   */
-  public DidResolverException(Throwable cause) {
-    super(cause);
-  }
-
-  /**
-   * Instantiates a new Did resolver exception with a message from another exception, allowing for
-   * disabling and printing the stack trace.
-   *
-   * @param message the message
-   * @param cause the cause
-   * @param enableSuppression the enable suppression
-   * @param writableStackTrace the writable stack trace
-   */
-  public DidResolverException(
-      String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
-    super(message, cause, enableSuppression, writableStackTrace);
-  }
-}
+ import org.eclipse.tractusx.ssi.lib.exception.SSIException;
+ 
+ /** The type Did resolver exception. */
+ public class DidResolverException extends SSIException {
+ 
+   private static final long serialVersionUID = 1L;
+   /**
+    * Instantiates a new Did resolver exception.
+    *
+    * @param message the message
+    */
+   public DidResolverException(String message) {
+     super(message);
+   }
+ 
+   /**
+    * Instantiates a new Did resolver exception from another exception with a message.
+    *
+    * @param message the message
+    * @param cause the cause
+    */
+   public DidResolverException(String message, Throwable cause) {
+     super(message, cause);
+   }
+ 
+   /**
+    * Instantiates a new Did resolver exception from another exception.
+    *
+    * @param cause the cause
+    */
+   public DidResolverException(Throwable cause) {
+     super(cause);
+   }
+ 
+   /**
+    * Instantiates a new Did resolver exception with a message from another exception, allowing for
+    * disabling and printing the stack trace.
+    *
+    * @param message the message
+    * @param cause the cause
+    * @param enableSuppression the enable suppression
+    * @param writableStackTrace the writable stack trace
+    */
+   public DidResolverException(
+       String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
+     super(message, cause, enableSuppression, writableStackTrace);
+   }
+ }
diff --git a/src/main/java/org/eclipse/tractusx/ssi/lib/exception/json/InvalidJsonLdException.java b/src/main/java/org/eclipse/tractusx/ssi/lib/exception/json/InvalidJsonLdException.java
@@ -19,36 +19,51 @@
  * *******************************************************************************
  */
 
-package org.eclipse.tractusx.ssi.lib.exception.json;
+ package org.eclipse.tractusx.ssi.lib.exception.json;
 
-import org.eclipse.tractusx.ssi.lib.exception.SSIException;
-
-public class InvalidJsonLdException extends SSIException {
-  public InvalidJsonLdException(String message) {
-    super(message);
-  }
-
-  /**
-   * Instantiates a new Invalid json ld exception.
-   *
-   * @param message the message
-   * @param cause the cause
-   */
-  public InvalidJsonLdException(String message, Throwable cause) {
-    super(message, cause);
-  }
-
-  /**
-   * Instantiates a new Invalid json ld exception.
-   *
-   * @param cause the cause
-   */
-  public InvalidJsonLdException(Throwable cause) {
-    super(cause);
-  }
-
-  public InvalidJsonLdException(
-      String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
-    super(message, cause, enableSuppression, writableStackTrace);
-  }
-}
+ import org.eclipse.tractusx.ssi.lib.exception.SSIException;
+
+ /** The type Invalid json ld exception. */
+ public class InvalidJsonLdException extends SSIException {
+   private static final long serialVersionUID = 1L;
+   /**
+    * Instantiates a new Invalid json ld exception.
+    *
+    * @param message the message
+    */
+   public InvalidJsonLdException(String message) {
+     super(message);
+   }
+
+   /**
+    * Instantiates a new Invalid json ld exception.
+    *
+    * @param message the message
+    * @param cause the cause
+    */
+   public InvalidJsonLdException(String message, Throwable cause) {
+     super(message, cause);
+   }
+
+   /**
+    * Instantiates a new Invalid json ld exception.
+    *
+    * @param cause the cause
+    */
+   public InvalidJsonLdException(Throwable cause) {
+     super(cause);
+   }
+
+   /**
+    * Instantiates a new Invalid json ld exception.
+    *
+    * @param message the message
+    * @param cause the cause
+    * @param enableSuppression the enable suppression
+    * @param writableStackTrace the writable stack trace
+    */
+   public InvalidJsonLdException(
+       String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
+     super(message, cause, enableSuppression, writableStackTrace);
+   }
+ }