Merge pull request #6 from javaquery/v1.0.6

V1.0.6

Author: javaquery

README.md

@@ -38,19 +38,20 @@ framework and objects.
 - <b>Regex</b>: Provides wide range of operation using regular expression like <code>isNumber(String value)</code>
   , <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.
 
 # Maven
 
 ```
 <dependency>
   <groupId>com.javaquery</groupId>
   <artifactId>util</artifactId>
-  <version>1.0.5</version>
+  <version>1.0.6</version>
 </dependency>
 ``` 
 
 # Gradle
 
 ```
-implementation 'com.javaquery:util:1.0.5'
+implementation 'com.javaquery:util:1.0.6'
 ```

build.gradle

@@ -5,7 +5,7 @@ plugins {
 }
 
 group 'com.javaquery'
-version '1.0.5'
+version '1.0.6'
 
 repositories {
     mavenCentral()
@@ -15,6 +15,8 @@ dependencies {
     implementation('org.slf4j:slf4j-api:+')
     implementation('org.json:json:+')
 
+    testImplementation 'net.logstash.logback:logstash-logback-encoder:6.6'
+    testImplementation group: 'ch.qos.logback', name: 'logback-classic', version: '+'
     testImplementation('org.junit.jupiter:junit-jupiter:5.7.0')
 }
 

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

@@ -1,5 +1,7 @@
 package com.javaquery.util;
 
+import com.javaquery.util.collection.function.ExecutableFunction;
+
 /**
  * @author vicky.thakor
  * @since 1.0
@@ -18,6 +20,18 @@ public static boolean isNull(Object obj) {
     return obj == null;
   }
 
+  /**
+   * Execute code if the provided reference is {@code null}.
+   *
+   * @param obj a reference to be checked against {@code null}
+   * @param executableFunction lambda function given executed if the provided reference is {@code null}.
+   */
+  public static void isNull(Object obj, ExecutableFunction executableFunction){
+    if(isNull(obj)){
+      executableFunction.execute();
+    }
+  }
+
   /**
    * Returns {@code true} if the provided reference is non-{@code null} otherwise returns {@code
    * false}.
@@ -29,6 +43,18 @@ public static boolean nonNull(Object obj) {
     return obj != null;
   }
 
+  /**
+   * Execute code if the provided reference is non-{@code null}.
+   *
+   * @param obj a reference to be checked against {@code null}
+   * @param executableFunction lambda function given executed if the provided reference is non-{@code null}.
+   */
+  public static void nonNull(Object obj, ExecutableFunction executableFunction){
+    if(nonNull(obj)){
+      executableFunction.execute();
+    }
+  }
+
   /**
    * Returns {@code true} if the arguments are equal to each other and {@code false} otherwise.
    * Consequently, if both arguments are {@code null}, {@code true} is returned and if exactly one

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

@@ -2,14 +2,18 @@
 
 import com.javaquery.util.Assert;
 import com.javaquery.util.Objects;
+import com.javaquery.util.collection.function.ExecutableFunction;
 
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.stream.IntStream;
 import java.util.stream.Stream;
 
+import static java.util.Collections.*;
+
 /**
  * @author vicky.thakor
  * @since 1.0
@@ -18,6 +22,72 @@ public final class Collections {
 
   private Collections() {}
 
+  /**
+   * Provide access to {@link java.util.Collections} method singleton.<br/>
+   *
+   * Returns an immutable set containing only the specified object. The returned set is serializable.
+   *
+   * @param o the sole object to be stored in the returned set.
+   * @param <T> the class of the objects in the set
+   * @return an immutable set containing only the specified object.
+   */
+  public static <T> Set<T> singleton(T o) {
+    return java.util.Collections.singleton(o);
+  }
+
+  /**
+   * 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
+   * @return an immutable list containing only the specified object.
+   */
+  public static <T> List<T> singletonList(T o) {
+    return java.util.Collections.singletonList(o);
+  }
+
+  /**
+   * 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.
+   * @param value the value to which the returned map maps key.
+   * @param <K> the class of the map keys
+   * @param <V> the class of the map value
+   * @return an immutable map containing only the specified key-value mapping.
+   */
+  public static <K, V> Map<K, V> singletonMap(K key, V value) {
+    return java.util.Collections.singletonMap(key, value);
+  }
+
+  /**
+   * 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
+   */
+  public static <T> Set<T> emptySet() {
+    return EMPTY_SET;
+  }
+
+  /**
+   * 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/>
+   * 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
+   * @return an empty map
+   */
+  public static <K, V> Map<K, V> emptyMap() {
+    return EMPTY_MAP;
+  }
+
   /**
    * Returns {@code true} if the provided Collection [List, Set] is {@code null} or empty otherwise
    * returns {@code false}.
@@ -30,6 +100,17 @@ public static boolean nullOrEmpty(Collection<?> collection) {
     return Objects.isNull(collection) || collection.isEmpty();
   }
 
+  /**
+   * Execute code if the provided Collection [List, Set] is {@code null} or empty.
+   * @param collection a Collection [List, Set] to be checked against {@code null} or empty
+   * @param executableFunction lambda function given executed if the provided Collection [List, Set] is {@code null} or empty.
+   */
+  public static void nullOrEmpty(Collection<?> collection, ExecutableFunction executableFunction) {
+    if(nullOrEmpty(collection)){
+      executableFunction.execute();
+    }
+  }
+
   /**
    * Returns {@code true} if the provided Collection [List, Set] is non-{@code null} and non-empty
    * otherwise returns {@code false}.
@@ -43,7 +124,18 @@ public static boolean nonNullNonEmpty(Collection<?> collection) {
   }
 
   /**
-   * Returns {@code true} if the provided Map is {@code null} and empty otherwise returns {@code
+   * Execute code if the provided Collection [List, Set] is non-{@code null} and non-empty.
+   * @param collection collection a Collection [List, Set] to be checked against non-{@code null} and non-empty
+   * @param executableFunction lambda function given executed if the provided Collection [List, Set] is non-{@code null} and non-empty.
+   */
+  public static void  nonNullNonEmpty(Collection<?> collection, ExecutableFunction executableFunction){
+    if(nonNullNonEmpty(collection)){
+      executableFunction.execute();
+    }
+  }
+
+  /**
+   * Returns {@code true} if the provided Map is {@code null} or empty otherwise returns {@code
    * false}.
    *
    * @param map a Map to be checked against {@code null} or empty
@@ -54,6 +146,17 @@ public static boolean nullOrEmpty(Map<?, ?> map) {
     return Objects.isNull(map) || map.isEmpty();
   }
 
+  /**
+   * Execute code if the provided Map is {@code null} or empty
+   * @param map a Map to be checked against {@code null} or empty
+   * @param executableFunction lambda function given executed if the provided Map is {@code null} or empty
+   */
+  public static void nullOrEmpty(Map<?, ?> map, ExecutableFunction executableFunction){
+    if(nullOrEmpty(map)){
+      executableFunction.execute();
+    }
+  }
+
   /**
    * Returns {@code true} if the provided Map is non-{@code null} and non-empty otherwise returns
    * {@code false}.
@@ -66,6 +169,17 @@ public static boolean nonNullNonEmpty(Map<?, ?> map) {
     return Objects.nonNull(map) && !map.isEmpty();
   }
 
+  /**
+   * Execute code if the provided Map is non-{@code null} and non-empty
+   * @param map  a Map to be checked against non-{@code null} and non-empty
+   * @param executableFunction lambda function given executed if the provided Map is non-{@code null} and non-empty
+   */
+  public static void nonNullNonEmpty(Map<?, ?> map, ExecutableFunction executableFunction){
+    if(nonNullNonEmpty(map)){
+      executableFunction.execute();
+    }
+  }
+
   /**
    * Returns stream of batched List from original List by given batch size.
    *

src/main/java/com/javaquery/util/collection/function/ExecutableFunction.java

@@ -0,0 +1,10 @@
+package com.javaquery.util.collection.function;
+
+/**
+ * @author vicky.thakor
+ * @since 1.0.6
+ */
+@FunctionalInterface
+public interface ExecutableFunction {
+    void execute();
+}

src/main/java/com/javaquery/util/io/Files.java

@@ -21,6 +21,10 @@
 public final class Files {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(Files.class);
+  /**
+   * returns the system temporary directory location
+   */
+  public static final String SYSTEM_TMP_DIR = System.getProperty("java.io.tmpdir");
 
   /**
    * Create new, empty file at specified path in {@link File} object. This method will also creates

src/main/java/com/javaquery/util/io/JFile.java

@@ -41,7 +41,7 @@ public String getExtension() {
    *     access to either the old or new pathnames
    * @throws NullPointerException If parameter <code>dest</code> is <code>null</code>
    */
-  public final JFile rename(String name) {
+  public JFile rename(String name) {
     Assert.nonNull(name, NullPointerException::new);
     if (exists()) {
       boolean result = renameTo(new File(getParent() + File.separatorChar + name));
@@ -53,12 +53,12 @@ public final JFile rename(String name) {
   }
 
   /** @return String content of this file. */
-  public final String read() {
+  public String read() {
     return Files.readFromFile(this);
   }
 
   /** @param data data to write to this file */
-  public final void write(String data) {
+  public void write(String data) {
     Files.writeToFile(this, data);
   }
 
@@ -67,25 +67,25 @@ public final void write(String data) {
    * @param appendNewLine <code>true</code> to append new line at the end of data otherwise <code>
    *     false</code>
    */
-  public final void append(String data, boolean appendNewLine) {
+  public void append(String data, boolean appendNewLine) {
     Files.appendToFile(this, data, appendNewLine);
   }
 
   /** @return attributes of file */
-  public final Map<String, String> getAttributes() {
+  public Map<String, String> getAttributes() {
     return attributes;
   }
 
   /**
    * @param key a key of attribute
    * @param value a value of attribute
    */
-  public final void addAttribute(String key, String value) {
+  public void addAttribute(String key, String value) {
     attributes.put(key, value);
   }
 
   /** @param attributes add attributes map to file */
-  public final void addAllAttribute(Map<String, String> attributes) {
+  public void addAllAttribute(Map<String, String> attributes) {
     if (Collections.nonNullNonEmpty(attributes)) {
       this.attributes.putAll(attributes);
     }
@@ -96,7 +96,7 @@ public final void addAllAttribute(Map<String, String> attributes) {
    * @param defaultValue default value in case attribute not found
    * @return attribute value if found otherwise defaultValue
    */
-  public final String optAttribute(String key, String defaultValue) {
+  public String optAttribute(String key, String defaultValue) {
     return attributes.getOrDefault(key, defaultValue);
   }
 }

src/main/java/com/javaquery/util/logging/Action.java

@@ -0,0 +1,10 @@
+package com.javaquery.util.logging;
+
+/**
+ * @author vicky.thakor
+ * @since 1.0.6
+ *
+ * Implement this interface for {@link LogBuilder} actions.
+ */
+public interface Action {
+}