LibraryInfo: introduced DirectoryPath API for the rest of paths

Author: pavly-gerges

snaploader/src/main/java/electrostatic4j/snaploader/LibraryInfo.java

@@ -60,8 +60,8 @@
  */
 public final class LibraryInfo {
 
-    private String jarPath;
-    private String directory;
+    private DirectoryPath jarPath;
+    private DirectoryPath directory;
     private String baseName;
     private DirectoryPath directoryPath;
 
@@ -71,25 +71,29 @@ public final class LibraryInfo {
      * @param directory the platform-independent directory inside the compression used for locating the native dynamic library,
      *                  this is used as a backup directory path
      *                  in case the {@link NativeDynamicLibrary#getPlatformDirectory()} is not valid.
-     * @param baseName the library basename, for example, 'lib-basename.so'.
-     * @param directoryPath the extraction destination in absolute string format, "null" if the current [user.dir] is
-     *                      specified as the extraction directory
+     * @param baseName the library basename, for example, 'lib-basename.so' (not null).
+     * @param directoryPath the extraction destination path, {@link DirectoryPath#USER_DIR} for
+     *                      a user working directory extraction path,
+     *                      and {@link DirectoryPath#USER_HOME} for the user home (not null).
      */
-    public LibraryInfo(String directory, String baseName, DirectoryPath directoryPath) {
-        this(null, directory, baseName, directoryPath);
+    public LibraryInfo(DirectoryPath directory, String baseName, DirectoryPath directoryPath) {
+        this(DirectoryPath.CLASS_PATH, directory, baseName, directoryPath);
     }
 
     /**
      * Instantiates a library info data structure pointing to a library in an external jar with jarPath.
      * 
-     * @param jarPath a path to an external jar to locate the library inside, "null" to use the project jar (classpath).
+     * @param jarPath a path to an external jar to locate the library inside, {@link DirectoryPath#CLASS_PATH} to assign the classpath routine
+     *                to the {@link electrostatic4j.snaploader.filesystem.FileLocator} API (not null).
      * @param directory the platform-independent directory inside the compression used for locating the native dynamic library,
      *                  this is used as a backup directory path
      *                  in case the {@link NativeDynamicLibrary#getPlatformDirectory()} is not valid.
-     * @param baseName the library basename, for example, 'lib-basename.so'.
-     * @param directoryPath the extraction destination in absolute string format
+     * @param baseName the library basename, for example, 'lib-basename.so' (not null).
+     * @param directoryPath the extraction destination path, {@link DirectoryPath#USER_DIR} for
+     *                      a user working directory extraction path,
+     *                      and {@link DirectoryPath#USER_HOME} for the user home (not null).
      */
-    public LibraryInfo(String jarPath, String directory, String baseName, DirectoryPath directoryPath) {
+    public LibraryInfo(DirectoryPath jarPath, DirectoryPath directory, String baseName, DirectoryPath directoryPath) {
         this.jarPath = jarPath;
         this.directory = directory;
         this.baseName = baseName;
@@ -109,27 +113,25 @@ public String getBaseName() {
      * Retrieves the jar filesystem path, the jar is the compression used to locate the native dynamic library to
      * be extracted and loaded by {@link NativeBinaryLoader}.
      * 
-     * @return the jar absolute filesystem path in a string format, "null" if the classpath is specified instead of
-     *         an external jar compression
+     * @return the jar absolute filesystem path object.
      */
-    public String getJarPath() {
+    public DirectoryPath getJarPath() {
         return jarPath;
     }
 
     /**
      * Retrieves the directory inside the compression used for locating the native dynamic library.
      * 
-     * @return the path to the dynamic library filesystem inside the compression, "null" if the
-     *         default variant-based directories are set to be used
+     * @return the path to the dynamic library filesystem inside the compression.
      */
-    public String getDirectory() {
+    public DirectoryPath getDirectory() {
         return directory;
     }
 
     /**
      * Retrieves the extraction absolute directory.
      * 
-     * @return the extraction destination in absolute string format
+     * @return the extraction destination path object.
      */
     public DirectoryPath getExtractionDirectory() {
         return directoryPath;
@@ -139,21 +141,20 @@ public DirectoryPath getExtractionDirectory() {
      * Sets the absolute path to the jar filesystem to locate the native dynamic library to be
      * extracted and loaded, "null" to use the "classpath (the stock jar)"" to load the library filesystem.
      * 
-     * @param jarPath the absolute path to the jar filesystem to locate the library to be extracted, "null" to
-     *                use the "classpath" (aka. the stock jar)
+     * @param jarPath the external jar path object to localize the compression, use {@link DirectoryPath#CLASS_PATH}
+     *                to switch the file locator to the classpath routine.
      */
-    public void setJarPath(String jarPath) {
+    public void setJarPath(DirectoryPath jarPath) {
         this.jarPath = jarPath;
     }
 
     /**
      * Sets the directory to the native dynamic library inside the jar compression, "null" to use
      * the default directories specified for each variant by {@link NativeBinaryLoader}.
      * 
-     * @param directory the location to the native dynamic library inside the jar compression, "null"
-     *                  to use the default variant-based directories
+     * @param directory the location to the native dynamic library inside the jar compression.
      */
-    public void setDirectory(String directory) {
+    public void setDirectory(DirectoryPath directory) {
         this.directory = directory;
     }
 
@@ -167,11 +168,10 @@ public void setBaseName(final String baseName) {
     }
 
     /**
-     * Sets the extraction directory used for extracting the native dynamic library in the 
-     * form of an absolute directory, "null" to use the current [user.dir].
+     * Sets the extraction directory used for extracting the native dynamic library.
      * 
-     * @param directoryPath the absolute extraction directory to which the located library
-     *                      will be extracted to
+     * @param directoryPath the extraction directory path to which the native-located library
+     *                      will be extracted to.
      */
     public void setExtractionDirectory(DirectoryPath directoryPath) {
         this.directoryPath = directoryPath;