Changeset 2d15f8e1 for launchers

Timestamp:

May 1, 2018 3:15:44 AM (2 years ago)

Author:

meeh <meeh@…>

Branches:

master

Children:

975d8a0

Parents:

a3a8ee1

Message:

Improved code documentation and readableness in form of syntax cleanup.

Location:

launchers/common/src/main/scala/net/i2p/launchers

Files:

• DeployProfile.scala (modified) (1 diff)
• OSXDeployment.scala (modified) (2 diffs)

launchers/common/src/main/scala/net/i2p/launchers/DeployProfile.scala

@@ -4 +4 @@
 
 
+/**
+  *
+  * This is a singleton ish style. It's an object - it was never a class.
+  * However it has a class-"brother/sister"
+  *
+  * objects like this should be considered like containers for java's
+  * public static methods.
+  *
+  * Many classes/objects benefits from pathJoin, so therefore it's defined
+  * as an "public static method".
+  *
+  * @since 0.9.35
+  */
 object DeployProfile {
 

launchers/common/src/main/scala/net/i2p/launchers/OSXDeployment.scala

@@ -158 +158 @@
 
   /**
+    * Please note that in Scala, the constructor body is same as class body.
+    * What's defined outside of methods is considered constructor code and
+    * executed as it.
+    *
+    *
+    *
     * a map function work as a loop with some built in security
     * for "null" objects.
@@ -166 +172 @@
     * the match case is controlling the flow based upon which type of object it is.
     */
-  staticFilesFromResources.map { fd => fd.getContent match {
-    case Left(is) => {
-      // Write file
-      if (!new File(DeployProfile.pathJoin(baseDir, fd.getPath)).exists()) {
-        println(s"copyBaseFileResToDisk(${fd.getPath})")
-        try {
-          copyBaseFileResToDisk(fd.getPath, is)
-        } catch {
-          case ex:IOException => println(s"Error! Exception ${ex}")
+  staticFilesFromResources.map {
+    fd => fd.getContent match {
+        // Case subject is a file/resource
+      case Left(is) => {
+        // Write file
+        if (!new File(DeployProfile.pathJoin(baseDir, fd.getPath)).exists()) {
+          println(s"copyBaseFileResToDisk(${fd.getPath})")
+          try {
+            copyBaseFileResToDisk(fd.getPath, is)
+          } catch {
+            case ex:IOException => println(s"Error! Exception ${ex}")
+          }
         }
       }
+        // Case subject is a directory
+      case Right(dir) => {
+        // Ensure directory
+        println(s"Directory(${fd.getPath})")
+        if (!new File(DeployProfile.pathJoin(baseDir,fd.getPath)).exists()) {
+          new File(DeployProfile.pathJoin(baseDir,fd.getPath)).mkdirs()
+        }
+        dir.map { f => createFileOrDirectory(f,fd.filesIsDirectories) }
+      }
     }
-    case Right(dir) => {
-      // Ensure directory
-      println(s"Directory(${fd.getPath})")
-      if (!new File(DeployProfile.pathJoin(baseDir,fd.getPath)).exists()) {
-        new File(DeployProfile.pathJoin(baseDir,fd.getPath)).mkdirs()
-      }
-      dir.map { f => createFileOrDirectory(f,fd.filesIsDirectories) }
-    }
-  } }
+  }
 
 }