fix/missing java docs

Author: piotr-szewczyk

.idea/workspace.xml

@@ -6,14 +6,32 @@
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * Default implementation of the {@link com.traceo.sdk.http.IRequest} interface.
+ * This class should be used only for internal SDK operations.
+ * @param <T> Content type class defined what should be sent in request.
+ */
 public class DefaultRequest<T> implements IRequest<T> {
 
+    /**
+     * Payload which should be sent in request.
+     */
     private T content;
 
+    /**
+     * Headers which should be included in request.
+     */
     private Map<String, String> headers = new HashMap<>();
 
+    /**
+     * {@link com.traceo.sdk.http.HttpMethod} for request.
+     */
     private HttpMethod httpMethod = HttpMethod.POST;
 
+    /**
+     * Path used to build full URI which is needed for request.
+     * URI is created with using provided host in {@link com.traceo.sdk.builder.ClientCoreConfiguration} concatenated with this value.
+     */
     private String endpoint;
 
     public DefaultRequest() {}

traceo-sdk-core/src/main/java/com/traceo/sdk/DefaultRequest.java

@@ -4,14 +4,33 @@
 import java.util.List;
 
 public class TraceoIncident {
+    /**
+     * Name of the captured incident. In case of this SDK
+     * name is defined by class name of the occured exception
+     * eq. java.lang.NullPointerException.
+     */
     private String name;
 
+    /**
+     * Name of the captured incident. In case of this SDK
+     * name is defined by class name of the occured exception
+     * eq. java.lang.NullPointerException.
+     */
     private String message;
 
+    /**
+     * Full stacktrace of the captured exception.
+     */
     private String stack;
 
+    /**
+     * Information about runtime platform on which exception has been catched.
+     */
     private TraceoRuntimePlatform platform = new TraceoRuntimePlatform();
 
+    /**
+     * List of objects contains information about each trace included in stacktrace.
+     */
     private List<TraceoTrace> traces = new ArrayList<>();
 
     public TraceoIncident() {}

traceo-sdk-core/src/main/java/com/traceo/sdk/TraceoIncident.java

@@ -1,20 +1,83 @@
 package com.traceo.sdk;
 
+/**
+ * Runtime platform information on which SDk is running.
+ */
 public class TraceoRuntimePlatform {
     private String arch;
 
-    private String platform;
+    private String name;
 
     private String release;
 
+    private String jvmName;
+
+    private String jvmVersion;
+
+    private String javaVersion;
+
+    private String javaVendor;
+
     public TraceoRuntimePlatform() {
-        this(System.getProperty("os.arch"), System.getProperty("os.name"), System.getProperty("os.release"));
+        this(
+                System.getProperty("os.arch"),
+                System.getProperty("os.name"),
+                System.getProperty("os.release"),
+                System.getProperty("java.vm.name"),
+                System.getProperty("java.vm.version"),
+                System.getProperty("java.version"),
+                System.getProperty("java.vendor")
+        );
     }
 
-    public TraceoRuntimePlatform(String arch, String name, String release) {
+    public TraceoRuntimePlatform(String arch, String name, String release, String jvmName, String jvmVersion, String javaVersion, String javaVendor) {
         this.arch = arch;
-        this.platform = name;
+        this.name = name;
         this.release = release;
+        this.jvmName = jvmName;
+        this.jvmVersion = jvmVersion;
+        this.javaVersion = javaVersion;
+        this.javaVendor = javaVendor;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getJvmName() {
+        return jvmName;
+    }
+
+    public void setJvmName(String jvmName) {
+        this.jvmName = jvmName;
+    }
+
+    public String getJvmVersion() {
+        return jvmVersion;
+    }
+
+    public void setJvmVersion(String jvmVersion) {
+        this.jvmVersion = jvmVersion;
+    }
+
+    public String getJavaVersion() {
+        return javaVersion;
+    }
+
+    public void setJavaVersion(String javaVersion) {
+        this.javaVersion = javaVersion;
+    }
+
+    public String getJavaVendor() {
+        return javaVendor;
+    }
+
+    public void setJavaVendor(String javaVendor) {
+        this.javaVendor = javaVendor;
     }
 
     public String getArch() {
@@ -26,11 +89,11 @@ public void setArch(String arch) {
     }
 
     public String getPlatform() {
-        return platform;
+        return name;
     }
 
     public void setPlatform(String platform) {
-        this.platform = platform;
+        this.name = platform;
     }
 
     public String getRelease() {

traceo-sdk-core/src/main/java/com/traceo/sdk/TraceoRuntimePlatform.java

@@ -1,24 +1,57 @@
 package com.traceo.sdk;
 
+/**
+ * An item creating after parsing each trace from the stacktrace.
+ */
 public class TraceoTrace {
+    /**
+     * Filename in which exception occur in this trace.
+     */
     private String filename;
 
+    /**
+     * Function name in which exception occur in this trace.
+     */
     private String function;
 
+    /**
+     * Line number in which exception occur in file for this trace.
+     */
     private int lineNo;
 
+    /**
+     * Column number in which exception occur in file for this trace.
+     */
     private int columnNo;
 
+    /**
+     * Specifies whether the exception occurred inside the owner's code or in an external library.
+     */
     private boolean isInternal;
 
+    /**
+     * Absolute path to the file with exception.
+     */
     private String absPath;
 
+    /**
+     * File extension.
+     */
     private String extension;
 
+    /**
+     * Code context for the single line in which exception occur in this file.
+     */
     private String code;
 
+    /**
+     * Code context for the five lines before exception line.
+     */
     private String[] preCode;
 
+    /**
+     * Code context for the five lines after exception line.
+     */
     private String[] postCode;
 
     public String getFilename() {

traceo-sdk-core/src/main/java/com/traceo/sdk/TraceoTrace.java

@@ -1,13 +1,30 @@
 package com.traceo.sdk.builder;
 
+/**
+ * Base client configuration class.
+ */
 public class ClientCoreConfiguration {
 
+    /**
+     * Api key generated in Traceo project.
+     */
     private String apiKey = null;
 
+    /**
+     * The host on which the Traceo instance is running.
+     * Host should be in format: [protocol]://[domain]:[port]
+     */
     private String host = null;
 
+    /**
+     * Specifies whether the SDK should be launched. If not then it will not collect any information.
+     * After changing the settings, it is necessary to restart the entire application.
+     */
     private boolean isEnabled = true;
 
+    /**
+     * Specifies if SDK should display internal logs.
+     */
     private boolean isDebug = false;
 
     public ClientCoreConfiguration() {}