Merge pull request #11 from javaquery/v1.2.0

V1.2.0

Author: javaquery

README.md

@@ -6,7 +6,7 @@ Welcome to the JavaQuery util library
 
 # Overview
 
-Goal is to remove repeated boler plate utility code from your project. This library offers util classes of following
+Goal is to remove repeated boilerplate utility code from your project. This library offers util classes of following
 framework and objects.
 
 - <b>Collections</b>: Provides wide range of operation you perform on collection (List, Set and Map) interfaces
@@ -39,19 +39,22 @@ framework and objects.
   , <code>isAlphaNumeric(String value)</code>, <code>isValidEmail(String value)</code>.
 - <b>UniqueIdGenerator</b>: Generate unique time based random alphanumeric string like Firebase keys.
 - <b>LogBuilder</b>: Help you to build Map for Markers used in logging with optional execution time of code or function.
+- <b>JHashMap</b>: Build on top of HashMap. Provide you extra functionality to opt values.
+- <b>ExecutionContext</b>: Help you to transfer data between method calls and log extra details.
+- <b>CommonResponse</b>: Build common http response object.
 
 # Maven
 
 ```
 <dependency>
   <groupId>com.javaquery</groupId>
   <artifactId>util</artifactId>
-  <version>1.0.7</version>
+  <version>1.2.0</version>
 </dependency>
 ``` 
 
 # Gradle
 
 ```
-implementation 'com.javaquery:util:1.0.7'
+implementation 'com.javaquery:util:1.2.0'
 ```

build.gradle

@@ -6,7 +6,7 @@ plugins {
 
 sourceCompatibility = 1.8
 group 'com.javaquery'
-version '1.0.7'
+version '1.2.0'
 
 repositories {
     mavenCentral()
@@ -15,6 +15,7 @@ repositories {
 dependencies {
     implementation('org.slf4j:slf4j-api:+')
     implementation('org.json:json:+')
+    implementation group: 'com.fasterxml.jackson.core', name: 'jackson-annotations', version: '2.13.2'
 
     testImplementation 'net.logstash.logback:logstash-logback-encoder:6.6'
     testImplementation group: 'ch.qos.logback', name: 'logback-classic', version: '+'

src/main/java/com/javaquery/util/ExecutionContext.java

@@ -0,0 +1,129 @@
+package com.javaquery.util;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.javaquery.util.logging.Action;
+import com.javaquery.util.time.Dates;
+
+import java.util.Date;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * @author vicky.thakor
+ * @since 1.2.0
+ */
+public class ExecutionContext<T> {
+
+    @JsonProperty("request_id")
+    private final String requestId;
+
+    @JsonProperty("reference_id")
+    private T referenceId;
+    private final Action action;
+    private Map<String, Object> meta;
+
+    @JsonProperty("max_retries")
+    private Integer maxRetries = 5;
+
+    @JsonProperty("retries_attempted")
+    private Integer retriesAttempted = 0;
+
+    @JsonProperty("created_at")
+    private final Date createdAt;
+
+    public ExecutionContext(String requestId, T referenceId, Action action) {
+        this.requestId = requestId;
+        this.referenceId = referenceId;
+        this.action = action;
+        this.meta = new HashMap<>();
+        this.createdAt = Dates.current();
+    }
+
+    public ExecutionContext(T referenceId, Action action) {
+        this.requestId = UniqueIdGenerator.generate();
+        this.referenceId = referenceId;
+        this.action = action;
+        this.meta = new HashMap<>();
+        this.createdAt = Dates.current();
+    }
+
+    public ExecutionContext(Action action) {
+        this.requestId = UniqueIdGenerator.generate();
+        this.action = action;
+        this.meta = new HashMap<>();
+        this.createdAt = Dates.current();
+    }
+
+    public ExecutionContext(T referenceId, Action action, Integer maxRetries) {
+        this.requestId = UniqueIdGenerator.generate();
+        this.referenceId = referenceId;
+        this.action = action;
+        this.maxRetries = maxRetries;
+        this.meta = new HashMap<>();
+        this.createdAt = Dates.current();
+    }
+
+    public ExecutionContext(Action action, Integer maxRetries) {
+        this.requestId = UniqueIdGenerator.generate();
+        this.action = action;
+        this.maxRetries = maxRetries;
+        this.meta = new HashMap<>();
+        this.createdAt = Dates.current();
+    }
+
+    public String getRequestId() {
+        return requestId;
+    }
+
+    public T getReferenceId() {
+        return referenceId;
+    }
+
+    public Action getAction() {
+        return action;
+    }
+
+    public Map<String, Object> getMeta() {
+        return meta;
+    }
+
+    public void setMeta(Map<String, Object> meta) {
+        this.meta = meta;
+    }
+
+    public Object getMeta(String key, Object defaultValue){
+        return meta.getOrDefault(key, defaultValue);
+    }
+
+    public void addMeta(String key, Object value){
+        this.meta.put(key, value);
+    }
+
+    public Integer getMaxRetries() {
+        return maxRetries;
+    }
+
+    public Integer getRetriesAttempted() {
+        return retriesAttempted;
+    }
+
+    public Date getCreatedAt() {
+        return createdAt;
+    }
+
+    public void addRetriesAttempted(Integer retriesAttempted) {
+        this.retriesAttempted += retriesAttempted;
+    }
+
+    @Override
+    public String toString() {
+        return "ExecutionContext{" +
+                "requestId='" + requestId + '\'' +
+                ", referenceId=" + referenceId +
+                ", action=" + action +
+                ", maxRetries=" + maxRetries +
+                ", retriesAttempted=" + retriesAttempted +
+                ", createdAt=" + createdAt +
+                '}';
+    }
+}

src/main/java/com/javaquery/util/collection/Collections.java

@@ -23,7 +23,7 @@ public final class Collections {
   private Collections() {}
 
   /**
-   * Provide access to {@link java.util.Collections} method singleton.<br/>
+   * Provide access to {@link java.util.Collections} method singleton.<br>
    *
    * Returns an immutable set containing only the specified object. The returned set is serializable.
    *
@@ -36,7 +36,7 @@ public static <T> Set<T> singleton(T o) {
   }
 
   /**
-   * Provide access to {@link java.util.Collections} method singletonList.<br/>
+   * Provide access to {@link java.util.Collections} method singletonList.<br>
    * Returns an immutable list containing only the specified object. The returned list is serializable.
    * @param o the class of the objects in the list
    * @param <T> the class of the objects in the list
@@ -47,7 +47,7 @@ public static <T> List<T> singletonList(T o) {
   }
 
   /**
-   * Provide access to {@link java.util.Collections} method singletonMap.<br/>
+   * Provide access to {@link java.util.Collections} method singletonMap.<br>
    * Returns an immutable map, mapping only the specified key to the specified value. The returned map is serializable.
    *
    * @param key the sole key to be stored in the returned map.
@@ -61,7 +61,7 @@ public static <K, V> Map<K, V> singletonMap(K key, V value) {
   }
 
   /**
-   * Provide access to {@link java.util.Collections} method emptySet.<br/>
+   * Provide access to {@link java.util.Collections} method emptySet.<br>
    * Returns an empty set (immutable). This set is serializable. Unlike the like-named field, this method is parameterized.
    * @param <T> the class of the objects in the set
    * @return the empty set
@@ -71,14 +71,14 @@ public static <T> Set<T> emptySet() {
   }
 
   /**
-   * Provide access to {@link java.util.Collections} method emptyList.<br/>
+   * Provide access to {@link java.util.Collections} method emptyList.<br>
    * @param <T> type of elements, if there were any, in the list
    * @return an empty immutable list
    */
   public static <T> List<T> emptyList() {return EMPTY_LIST;  }
 
   /**
-   * Provide access to {@link java.util.Collections} method emptyMap.<br/>
+   * Provide access to {@link java.util.Collections} method emptyMap.<br>
    * Returns an empty map (immutable). This map is serializable.
    * @param <K> the class of the map keys
    * @param <V> the class of the map values

src/main/java/com/javaquery/util/collection/JHashMap.java

@@ -0,0 +1,81 @@
+package com.javaquery.util.collection;
+
+import com.javaquery.util.Regex;
+
+import java.util.HashMap;
+
+/**
+ * @author vicky.thakor
+ * @since 1.2.0
+ */
+public class JHashMap<K, V> extends HashMap<K, V> {
+
+    /**
+     * @param key the key whose associated value is to be returned
+     * @return the value to which the specified key is mapped, or 0 if this map contains no mapping for the key
+     */
+    public Integer optInt(K key){
+        return optInt(key, 0);
+    }
+
+    /**
+     * @param key the key whose associated value is to be returned
+     * @param defaultValue the default mapping of the key
+     * @return the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key
+     */
+    @SuppressWarnings("unchecked")
+    public Integer optInt(K key, Integer defaultValue){
+        Object value = getOrDefault(key, (V) defaultValue);
+        if(value instanceof Number){
+            return ((Number) value).intValue();
+        }
+        String strValue = String.valueOf(value);
+        return Regex.isNumber(strValue) ? Integer.parseInt(strValue) : defaultValue;
+    }
+
+    /**
+     * @param key the key whose associated value is to be returned
+     * @return the value to which the specified key is mapped, or 0 if this map contains no mapping for the key
+     */
+    public Long optLong(K key){
+        return optLong(key, 0L);
+    }
+
+    /**
+     * @param key the key whose associated value is to be returned
+     * @param defaultValue the default mapping of the key
+     * @return the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key
+     */
+    @SuppressWarnings("unchecked")
+    public Long optLong(K key, Long defaultValue){
+        Object value = getOrDefault(key, (V) defaultValue);
+        if(value instanceof Number){
+            return ((Number) value).longValue();
+        }
+        String strValue = String.valueOf(value);
+        return Regex.isNumber(strValue) ? Long.parseLong(strValue) : defaultValue;
+    }
+
+    /**
+     * @param key the key whose associated value is to be returned
+     * @return the value to which the specified key is mapped, or 0 if this map contains no mapping for the key
+     */
+    public Double optDouble(K key){
+        return optDouble(key, 0D);
+    }
+
+    /**
+     * @param key the key whose associated value is to be returned
+     * @param defaultValue the default mapping of the key
+     * @return the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key
+     */
+    @SuppressWarnings("unchecked")
+    public Double optDouble(K key, Double defaultValue){
+        Object value = getOrDefault(key, (V) defaultValue);
+        if(value instanceof Number){
+            return ((Number) value).doubleValue();
+        }
+        String strValue = String.valueOf(value);
+        return Regex.isNumber(strValue) ? Double.parseDouble(strValue) : defaultValue;
+    }
+}

src/main/java/com/javaquery/util/http/CommonResponse.java

@@ -0,0 +1,70 @@
+package com.javaquery.util.http;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.io.Serializable;
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * @author vicky.thakor
+ * @since 1.2.0
+ */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class CommonResponse<T> implements Serializable {
+
+    @JsonProperty("status_code")
+    private final int statusCode;
+
+    @JsonProperty("message")
+    private final String message;
+
+    private final T payload;
+
+    @JsonProperty("error_messages")
+    private final List<String> errorMessages;
+
+    private CommonResponse(int statusCode, String message, T payload, List<String> errorMessages) {
+        this.statusCode = statusCode;
+        this.message = message;
+        this.payload = payload;
+        this.errorMessages = errorMessages;
+    }
+
+    public static <T> CommonResponse<T> ok(T payload){
+        return CommonResponse.of(HttpStatus.OK, payload);
+    }
+
+    public static <T> CommonResponse<T> of(HttpStatus statusCode, String message, T payload){
+        return new CommonResponse<>(statusCode.value(), message, payload, Collections.emptyList());
+    }
+
+    public static <T> CommonResponse<T> of(HttpStatus statusCode, String message){
+        return new CommonResponse<>(statusCode.value(), message, null, Collections.emptyList());
+    }
+
+    public static <T> CommonResponse<T> of(HttpStatus statusCode, T payload){
+        return new CommonResponse<>(statusCode.value(), null, payload, Collections.emptyList());
+    }
+
+    public static <T> CommonResponse<T> of(HttpStatus statusCode, List<String> errorMessages){
+        return new CommonResponse<>(statusCode.value(), null, null, errorMessages);
+    }
+
+    public int getStatusCode() {
+        return statusCode;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public T getPayload() {
+        return payload;
+    }
+
+    public List<String> getErrorMessages() {
+        return errorMessages;
+    }
+}