Make stuff public and add documentation so this may be used as a library

Author: SamCarlberg

src/main/java/edu/wpi/first/wpilib/opencv/installer/Installer.java

@@ -6,8 +6,6 @@
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
-import java.io.InputStream;
-import java.net.HttpURLConnection;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.nio.file.Files;
@@ -20,6 +18,8 @@
 /**
  * A command line application that downloads and installs OpenCV. This assumes that the OpenCV artifacts will be
  * available on the FRC maven server at http://first.wpi.edu/FRC/roborio/maven or in the local maven repository.
+ *
+ * <p>Install locations are specified by the current {@link Platform}</p>
  */
 @UtilityClass
 public class Installer {
@@ -58,7 +58,10 @@ private enum ArtifactType {
     }
 
 
-    public static void main(String... args) throws ParseException {
+    /**
+     * Main entry point.
+     */
+    public static void main(String[] args) throws ParseException {
         CommandLineParser p = new DefaultParser();
         Options options = new Options() {{
             addOption("j", "java", false, "Install the Java API jar in the working directory");
@@ -81,11 +84,9 @@ public static void main(String... args) throws ParseException {
             throw new MissingOptionException("-v <version>");
         }
         if (parsedArgs.hasOption("platform")) {
-            overridePlatform = true;
-            platform = Platform.valueOf(parsedArgs.getOptionValue("platform"));
+            setPlatform(Platform.valueOf(parsedArgs.getOptionValue("platform")));
         }
-        openCvVersion = parsedArgs.getOptionValue("version");
-        version = platform + "-" + openCvVersion;
+        setVersion(parsedArgs.getOptionValue("version"));
         overwrite = !parsedArgs.hasOption("no-overwrite");
         System.out.println("Installing specified OpenCV components");
         System.out.println("======================================");
@@ -106,22 +107,60 @@ public static void main(String... args) throws ParseException {
         System.out.println("Finished installing OpenCV");
     }
 
-    private static void installJava() {
+    /**
+     * Sets a specific platform to install. Artifacts will be downloaded into the working directory and will need to be
+     * manually installed.
+     *
+     * @param p the platform to get the artifacts for
+     */
+    public static void setPlatform(Platform p) {
+        platform = p;
+        calculateVersion();
+        overridePlatform = true;
+    }
+
+    /**
+     * Sets the version of OpenCV to get artifacts for.
+     *
+     * @param v the version of OpenCV to install
+     */
+    public static void setVersion(String v) {
+        openCvVersion = v;
+        calculateVersion();
+    }
+
+    private static void calculateVersion() {
+        version = platform + "-" + openCvVersion;
+    }
+
+    /**
+     * Downloads the Java API jar.
+     */
+    public static void installJava() {
         System.out.println("Installing Java");
         install(ArtifactType.JAVA);
     }
 
-    private static void installJni() {
+    /**
+     * Installs the JNI bindings.
+     */
+    public static void installJni() {
         System.out.println("Installing JNI");
         install(ArtifactType.JNI);
     }
 
-    private static void installHeaders() {
+    /**
+     * Installs the C++ headers.
+     */
+    public static void installHeaders() {
         System.out.println("Installing headers");
         install(ArtifactType.HEADERS);
     }
 
-    private static void installNatives() {
+    /**
+     * Installs the C++ native libraries.
+     */
+    public static void installNatives() {
         System.out.println("Installing natives");
         install(ArtifactType.NATIVES);
     }

src/main/java/edu/wpi/first/wpilib/opencv/installer/Platform.java

@@ -4,35 +4,53 @@
 import lombok.RequiredArgsConstructor;
 
 
+/**
+ * Enum values for supported platforms.
+ */
 @Getter
 @RequiredArgsConstructor
-enum Platform {
+public enum Platform {
 
     // TODO figure out Windows install locations
+    /**
+     * 32-bit Windows.
+     */
     win32(
             "",
             "",
             "",
             ""
     ),
+    /**
+     * 64-bit Windows.
+     */
     win64(
             "",
             "",
             "",
             ""
     ),
+    /**
+     * Mac OS X. Only versions 10.4 and above are supported.
+     */
     osx(
             "",
             UserHomeHolder.userHome + "/Library/Java/Extensions",
             "/usr/local/include",
             "/usr/local/lib"
     ),
+    /**
+     * 32-bit linux.
+     */
     linux32(
             "",
             "usr/local",
             "/usr/local/include",
             "/usr/local/lib"
     ),
+    /**
+     * 64-bit linux.
+     */
     linux64(
             "",
             "/usr/local",
@@ -44,9 +62,26 @@ private static final class UserHomeHolder {
         static final String userHome = System.getProperty("user.home");
     }
 
+    /**
+     * The location of installs for the Java library.
+     */
     private final String javaInstallLocation;
+
+    /**
+     * The location of installs for the JNI bindings. This should be in a location that is on {@code java.library.path}
+     * by default.
+     */
     private final String jniInstallLocation;
+
+    /**
+     * The location of installs for the C++ header files.
+     */
     private final String headersInstallLocation;
+
+    /**
+     * The location of installs for the native C++ libraries. This should be a default location on the path
+     * (e.g. {@code /usr/local/}).
+     */
     private final String nativesInstallLocation;
 
 }

src/main/java/edu/wpi/first/wpilib/opencv/installer/PlatformDetector.java

@@ -3,7 +3,7 @@
 import lombok.experimental.UtilityClass;
 
 @UtilityClass
-class PlatformDetector {
+public class PlatformDetector {
 
     private static String os = null;
     private static String arch = null;
@@ -20,7 +20,7 @@ class PlatformDetector {
      * @return the current operating system
      * @throws UnsupportedOperatingSystemError if the current operating system is not supported
      */
-    private static String getOs() throws UnsupportedOperatingSystemError {
+    public static String getOs() throws UnsupportedOperatingSystemError {
         if (os != null) {
             return os;
         }
@@ -47,7 +47,7 @@ private static String getOs() throws UnsupportedOperatingSystemError {
      * @return the operating system architecture
      * @throws UnsupportedOperatingSystemError if the architecture is not supported
      */
-    private static String getArch() throws UnsupportedOperatingSystemError {
+    public static String getArch() throws UnsupportedOperatingSystemError {
         if (arch != null) {
             return arch;
         }
@@ -67,7 +67,7 @@ private static String getArch() throws UnsupportedOperatingSystemError {
      *
      * @return the current platform
      */
-    static Platform getPlatform() {
+    public static Platform getPlatform() {
         if (platform != null) {
             return platform;
         }