Comments and minor refactorings #2043

src/main/java/org/lantern/browser/BrowserUtils.java

@@ -25,6 +25,13 @@ public class BrowserUtils {
 
     private BrowserUtils(){}
 
+    /**
+     * Adds the various default arguments to chrome.
+     * 
+     * @param commands The list of commands to add arguments to.
+     * @param windowWidth The desired window width.
+     * @param windowHeight The desired window height.
+     */
     public static void addDefaultChromeArgs(final List<String> commands, 
             final int windowWidth, final int windowHeight) {
 
@@ -49,7 +56,14 @@ public static void addDefaultChromeArgs(final List<String> commands,
         commands.add("--disable-extensions");
     }
 
-    public static void openSystemDefaultBrowser(String uri) {
+    /**
+     * Opens the specified URL in the operating system's default browser. 
+     * This does not return the process ID of the new window and therefore
+     * cannot be used if the caller needs to ever close the window.
+     * 
+     * @param uri The URI to open.
+     */
+    public static void openSystemDefaultBrowser(final String uri) {
         LOG.debug("Opening system default browser to: {}", uri);
         try {
             Desktop.getDesktop().browse(new URI(uri));
@@ -58,6 +72,13 @@ public static void openSystemDefaultBrowser(String uri) {
         }
     }
 
+    /**
+     * Runs the process specified in the given list of commands.
+     * 
+     * @param commands The list of commands to run.
+     * @return The process.
+     * @throws IOException If there's an error running the commands.
+     */
     public static Process runProcess(final List<String> commands) throws IOException {
         final ProcessBuilder processBuilder = new ProcessBuilder(commands);
 

src/main/java/org/lantern/browser/LanternBrowser.java

@@ -2,7 +2,20 @@
 
 import java.io.IOException;
 
+/**
+ * Interface for operating-specific browsers that display the Lantern user
+ * interface.
+ */
 public interface LanternBrowser {
 
+    /**
+     * Opens the URI to the Lantern user interface.
+     * 
+     * @param uri The URI to open.
+     * @return The {@link Process} for the new browser, allowing the caller
+     * to eventually close it, or <code>null</code> if a browser with an
+     * associated process could not be created.
+     * @throws IOException If there's an error opening the browser.
+     */
     Process open(String uri) throws IOException;
 }

src/main/java/org/lantern/browser/UbuntuBrowser.java

@@ -33,8 +33,6 @@ public UbuntuBrowser(final int windowWidth, final int windowHeight) {
     @Override
     public Process open(final String uri) throws IOException {
         log.info("Opening browser to: {}", uri);
-        final List<String> commands = new ArrayList<String>();
-
         final Collection<String> pathCandidates = new ArrayList<String>();
         pathCandidates.add("/usr/bin/google-chrome");
         pathCandidates.add("/usr/bin/google-chrome-stable");
@@ -46,6 +44,7 @@ public Process open(final String uri) throws IOException {
             final File opt = new File(path);
             if (opt.isFile() && opt.canExecute()) {
                 // http://peter.sh/experiments/chromium-command-line-switches/
+                final List<String> commands = new ArrayList<String>();
                 commands.add(path);
                 BrowserUtils.addDefaultChromeArgs(commands, this.windowWidth, this.windowHeight);
                 commands.add("--app=" + uri);

src/main/java/org/lantern/browser/WindowsBrowser.java

@@ -34,8 +34,6 @@ public WindowsBrowser(final int windowWidth, final int windowHeight) {
     }
 
     public Process open(final String uri) throws IOException {
-        final List<String> commands = new ArrayList<String>();
-
         final String executable = determineExecutable();
         if (StringUtils.isBlank(executable)) {
             // At this point we've effectively only searched for Chrome and
@@ -49,6 +47,7 @@ public Process open(final String uri) throws IOException {
                 throw new UnsupportedOperationException("Could not find Chrome!");
             }
         }
+        final List<String> commands = new ArrayList<String>();
         commands.add(executable);
         BrowserUtils.addDefaultChromeArgs(commands, this.windowWidth, 
                 this.windowHeight);