Introduced the StreamProvider API

Author: pavly-gerges

snaploader/src/main/java/electrostatic/snaploader/filesystem/InputStreamProvider.java

@@ -40,7 +40,7 @@
  * 
  * @author pavl_g
  */
-public interface InputStreamProvider extends AutoCloseable {
+public interface InputStreamProvider extends StreamProvider {
 
     /**
      * Retrieves the input stream object associated with this filesystem entry.

snaploader/src/main/java/electrostatic/snaploader/filesystem/OutputStreamProvider.java

@@ -40,7 +40,7 @@
  * 
  * @author pavl_g
  */
-public interface OutputStreamProvider extends AutoCloseable {
+public interface OutputStreamProvider extends StreamProvider {
 
     /**
      * Retrieves the input stream provider object (the filesystem locator object).

snaploader/src/main/java/electrostatic/snaploader/filesystem/StreamProvider.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2023-2024, The Electrostatic-Sandbox Distributed Simulation Framework, jSnapLoader
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of 'Electrostatic-Sandbox' nor the names of its contributors
+ *   may be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package electrostatic.snaploader.filesystem;
+
+/**
+ * A generic interface providing the main entry for
+ * all stream providers for buffered IO operations.
+ *
+ * @author pavl_g
+ */
+public interface StreamProvider extends AutoCloseable {
+
+    /**
+     * Initializes the buffered stream handler object.
+     *
+     * @param size the size of the buffered IO in bytes or zero
+     *             for auto filesystem size
+     */
+    void initialize(int size);
+
+    /**
+     * Generates a unique hash key for this object
+     * using an MSB to LSB spreading algorithm.
+     *
+     * @return an XoR operation of the MSBs (Most Significant Bits) with
+     *         the LSBs (the Least Significant Bits) of the object hash code
+     */
+    default int getHashKey() {
+        return (hashCode() >>> 16) ^ hashCode();
+    }
+}