feat: File util

Author: javaquery

build.gradle

@@ -12,7 +12,8 @@ repositories {
 }
 
 dependencies {
-    testCompile('org.junit.jupiter:junit-jupiter:5.7.0')
+    implementation('org.slf4j:slf4j-api:1.7.30')
+    testImplementation('org.junit.jupiter:junit-jupiter:5.7.0')
 }
 
 test {
@@ -71,7 +72,7 @@ publishing {
             url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
             credentials {
                 username "javaquery"
-                password "a2a@\$ASDF#777"
+                password "******"
             }
         }
     }

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

@@ -14,7 +14,8 @@
  */
 public final class Assert {
 
-    private Assert() {}
+    private Assert() {
+    }
 
     /**
      * <em>Assert</em> that {@code object} is {@code not null}.

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

@@ -6,7 +6,8 @@
  */
 public final class Objects {
 
-    private Objects(){}
+    private Objects() {
+    }
 
     /**
      * Returns {@code true} if the provided reference is {@code null} otherwise

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

@@ -8,15 +8,15 @@
  */
 public final class Regex {
 
-    private Regex(){}
-
     public static final String REGEX_NUMBER = "^-?[0-9]\\d*(\\.\\d+)?$";
     public static final String REGEX_ALPHA_NUMERIC = "^[a-zA-Z0-9]*$";
     public static final String REGEX_EMAIL =
             "^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))[^_@!*]*?$";
-
     public static final Pattern EMAIL_PATTERN = Pattern.compile(REGEX_EMAIL);
 
+    private Regex() {
+    }
+
     /**
      * Returns {@code true} if the provided String is valid number otherwise
      * returns {@code false}.

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

@@ -14,7 +14,8 @@
  */
 public final class Collections {
 
-    private Collections(){}
+    private Collections() {
+    }
 
     /**
      * Returns {@code true} if the provided Collection [List, Set] is {@code null} or empty otherwise

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

@@ -0,0 +1,178 @@
+package com.javaquery.util.io;
+
+import com.javaquery.util.Assert;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.nio.file.InvalidPathException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.StandardOpenOption;
+
+/**
+ * @author vicky.thakor
+ * @since 1.0
+ */
+public final class Files {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(Files.class);
+
+    /**
+     * Create new, empty file at specified path in {@link File} object.
+     * This method will also creates folder structure if not exists.
+     *
+     * Note: Exception is logged not thrown.
+     *
+     * @param file - file to create
+     * @param <T>
+     * @return <code>true</code> if the named file does not exist and was
+     * successfully created; <code>false</code> if the named file
+     * already exists
+     */
+    public static <T extends File> boolean createNewFile(T file) {
+        Assert.nonNull(file, NullPointerException::new);
+        if (!file.exists()) {
+            file.getParentFile().mkdirs();
+            try {
+                return file.createNewFile();
+            } catch (IOException e) {
+                LOGGER.error(e.getMessage(), e);
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Delete existing file and then Create new, empty file at
+     * specified path in {@link File} object.
+     *
+     * Note: Exception is logged not thrown.
+     *
+     * @param file - file to delete and create
+     * @param <T>
+     * @return <code>true</code> if the named file deleted and was
+     * successfully created; <code>false</code> if the named file
+     * already exists
+     */
+    public static <T extends File> boolean deleteAndCreateNewFile(T file){
+        Assert.nonNull(file, NullPointerException::new);
+        if(file.exists()){
+            file.delete();
+        }
+        return createNewFile(file);
+    }
+
+    /**
+     * Write data to provided file.
+     *
+     * Note: This method will also creates new <code>file</code> if not exist.
+     * Exception is logged not thrown.
+     *
+     * @param file file to write
+     * @param data data to write to file
+     * @param <T>
+     */
+    public static <T extends File> void writeToFile(T file, String data){
+        Assert.nonNull(file, NullPointerException::new);
+        Assert.nonNull(data, NullPointerException::new);
+        if(!file.exists()){
+            createNewFile(file);
+        }
+        try {
+            java.nio.file.Files.write(getPath(file), data.getBytes());
+        } catch (IOException | InvalidPathException e) {
+            LOGGER.error(e.getMessage(), e);
+        }
+    }
+
+    /**
+     * Append data to provided <code>file</code>
+     *
+     * Note: This method will also creates new <code>file</code> if not exist.
+     * Exception is logged not thrown.
+     *
+     * @param file file to write
+     * @param data data to append to file
+     * @param appendNewLine <code>true</code> to append new line at the end of data
+     *                      otherwise <code>false</code>.
+     * @param <T>
+     */
+    public static <T extends File> void appendToFile(T file, String data, boolean appendNewLine){
+        Assert.nonNull(file, NullPointerException::new);
+        Assert.nonNull(data, NullPointerException::new);
+        if(!file.exists()){
+            createNewFile(file);
+        }
+        data = appendNewLine ? (data + "\n") : data;
+        try {
+            java.nio.file.Files.write(getPath(file), data.getBytes(), StandardOpenOption.APPEND);
+        } catch (IOException | InvalidPathException e) {
+            LOGGER.error(e.getMessage(), e);
+        }
+    }
+
+    /**
+     * Read <code>String</code> content of <code>file</code>.
+     *
+     * Note: Exception is logged not thrown.
+     *
+     * @param file file to read
+     * @param <T>
+     * @return String data of file if exists otherwise <code>null</code>
+     */
+    public static <T extends File> String readFromFile(T file){
+        Assert.nonNull(file, NullPointerException::new);
+        if(file.exists()){
+            try {
+                return new String(java.nio.file.Files.readAllBytes(getPath(file)));
+            } catch (IOException | InvalidPathException e) {
+                LOGGER.error(e.getMessage(), e);
+            }
+        }
+        return null;
+    }
+
+    /**
+     * Read any file from resources folder of project.
+     * For example, read demo.json from provided path `resources folder` <code>/sample/demo.json</code>
+     *
+     * @param path path to resource
+     * @return String data of file if exists otherwise <code>null</code>
+     */
+    public String loadResource(String path){
+        Assert.nonNull(path, NullPointerException::new);
+        if(!path.trim().isEmpty()){
+            try(
+                InputStream inputStream = getClass().getResourceAsStream(path);
+                BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(inputStream))
+            ){
+                String fileLine;
+                StringBuilder stringBuilder = new StringBuilder();
+
+                while((fileLine = bufferedReader.readLine())!= null){
+                    stringBuilder.append(fileLine);
+                }
+                return stringBuilder.toString();
+            } catch (IOException | NullPointerException e) {
+                LOGGER.error(e.getMessage(), e);
+            }
+        }
+        return null;
+    }
+
+    /**
+     * Path of file provided
+     *
+     * @param file file to get {@link Path}.
+     * @param <T>
+     * @return {@link Path} of file
+     */
+    private static <T extends File> Path getPath(T file){
+        return Paths.get(file.getAbsolutePath());
+    }
+}

src/main/java/com/javaquery/util/string/Strings.java

@@ -12,10 +12,10 @@
  */
 public final class Strings {
 
-    private Strings(){}
-
     private final static String UNSUPPORTED_ASCII_PATTERN = "[^\\x20-\\x7e]";
     private final static String UNSUPPORTED_UNICODE_PATTERN = "[\\uD83C-\\uDBFF\\uDC00-\\uDFFF]+";
+    private Strings() {
+    }
 
     /**
      * Returns {@code true} if the provided String is {@code null} or empty otherwise

src/main/java/com/javaquery/util/time/DateRange.java

@@ -0,0 +1,33 @@
+package com.javaquery.util.time;
+
+import java.util.Date;
+
+/**
+ * @author vicky.thakor
+ * @since 1.0
+ */
+public final class DateRange {
+
+    private Date startDate;
+    private Date endDate;
+
+    private DateRange() {
+    }
+
+    public DateRange(Date startDate, Date endDate) {
+        this.startDate = startDate;
+        this.endDate = endDate;
+    }
+
+    public DateRange(Date startDate) {
+        this(startDate, new Date());
+    }
+
+    public Date getStartDate() {
+        return startDate;
+    }
+
+    public Date getEndDate() {
+        return endDate;
+    }
+}

src/main/java/com/javaquery/util/time/Dates.java

@@ -14,10 +14,10 @@
  */
 public final class Dates {
 
-    private Dates(){}
-
     public static final TimeZone SYSTEM_TIMEZONE = TimeZone.getDefault();
     private static final Calendar CALENDAR = Calendar.getInstance();
+    private Dates() {
+    }
 
     /**
      * @return current time in milliseconds by using System.currentTimeMillis()
@@ -223,13 +223,14 @@ public enum Month {
                 11), DECEMBER(12);
 
         private int value;
+        private final static Calendar calendar = Calendar.getInstance();
 
         Month(int value) {
             this.value = value;
         }
 
         public static Month currentMonth() {
-            return Month.values()[CALENDAR.get(Calendar.MONTH)];
+            return Month.values()[calendar.get(Calendar.MONTH)];
         }
 
         public int getValue() {

src/main/resources/sample/demo.json

@@ -0,0 +1 @@
+{"name": "vicky thakor"}