ADT & libs: change ISdkLog to be a mandatory non-null parameter.

Mostly a javadoc change describing the log arguments as necessary.
In the SDK & AVD Manager code, also removed the log!=null checks.
This makes it consistent with the repository code too which
already had this assumption.

SD Bug 2477460

Change-Id: I5ba7ae6a2c7685805e43a115359f99f2f0caa815

diff --git a/sdkmanager/libs/sdklib/src/com/android/sdklib/NullSdkLog.java b/sdkmanager/libs/sdklib/src/com/android/sdklib/NullSdkLog.java
index e860f5b..fb4813b 100644 (file)
--- a/sdkmanager/libs/sdklib/src/com/android/sdklib/NullSdkLog.java
+++ b/sdkmanager/libs/sdklib/src/com/android/sdklib/NullSdkLog.java
@@ -20,7 +20,6 @@ package com.android.sdklib;
  * Dummy implementation of an {@link ISdkLog}.
  * <p/>
  * Use {@link #getLogger()} to get a default instance of this {@link NullSdkLog}.
- *
  */
 public class NullSdkLog implements ISdkLog {
 

diff --git a/sdkmanager/libs/sdklib/src/com/android/sdklib/SdkManager.java b/sdkmanager/libs/sdklib/src/com/android/sdklib/SdkManager.java
index 30b77bc..81bff9c 100644 (file)
--- a/sdkmanager/libs/sdklib/src/com/android/sdklib/SdkManager.java
+++ b/sdkmanager/libs/sdklib/src/com/android/sdklib/SdkManager.java
@@ -103,7 +103,7 @@ public final class SdkManager {
     /**
      * Creates an {@link SdkManager} for a given sdk location.
      * @param sdkLocation the location of the SDK.
-     * @param log the ISdkLog object receiving warning/error from the parsing. Can be null.
+     * @param log the ISdkLog object receiving warning/error from the parsing. Cannot be null.
      * @return the created {@link SdkManager} or null if the location is not valid.
      */
     public static SdkManager createManager(String sdkLocation, ISdkLog log) {
@@ -123,9 +123,7 @@ public final class SdkManager {
 
             return manager;
         } catch (IllegalArgumentException e) {
-            if (log != null) {
-                log.error(e, "Error parsing the sdk.");
-            }
+            log.error(e, "Error parsing the sdk.");
         }
 
         return null;
@@ -212,7 +210,8 @@ public final class SdkManager {
 
     /**
      * Reloads the content of the SDK.
-     * @param log the ISdkLog object receiving warning/error from the parsing.
+     *
+     * @param log the ISdkLog object receiving warning/error from the parsing. Cannot be null.
      */
     public void reloadSdk(ISdkLog log) {
         // get the current target list.
@@ -236,7 +235,7 @@ public final class SdkManager {
      * Loads the Platforms from the SDK.
      * @param location Location of the SDK
      * @param list the list to fill with the platforms.
-     * @param log the ISdkLog object receiving warning/error from the parsing. Can be null.
+     * @param log the ISdkLog object receiving warning/error from the parsing. Cannot be null.
      */
     private static void loadPlatforms(String location, ArrayList<IAndroidTarget> list,
             ISdkLog log) {
@@ -250,7 +249,7 @@ public final class SdkManager {
                     if (target != null) {
                         list.add(target);
                     }
-                } else if (log != null) {
+                } else {
                     log.warning("Ignoring platform '%1$s', not a folder.", platform.getName());
                 }
             }
@@ -272,7 +271,7 @@ public final class SdkManager {
     /**
      * Loads a specific Platform at a given location.
      * @param platform the location of the platform.
-     * @param log the ISdkLog object receiving warning/error from the parsing. Can be null.
+     * @param log the ISdkLog object receiving warning/error from the parsing. Cannot be null.
      */
     private static PlatformTarget loadPlatform(File platform, ISdkLog log) {
         File buildProp = new File(platform, SdkConstants.FN_BUILD_PROP);
@@ -286,12 +285,10 @@ public final class SdkManager {
                 // version string
                 String apiName = map.get(PROP_VERSION_RELEASE);
                 if (apiName == null) {
-                    if (log != null) {
-                        log.error(null,
-                                "Ignoring platform '%1$s': %2$s is missing from '%3$s'",
-                                platform.getName(), PROP_VERSION_RELEASE,
-                                SdkConstants.FN_BUILD_PROP);
-                    }
+                    log.error(null,
+                            "Ignoring platform '%1$s': %2$s is missing from '%3$s'",
+                            platform.getName(), PROP_VERSION_RELEASE,
+                            SdkConstants.FN_BUILD_PROP);
                     return null;
                 }
 
@@ -299,12 +296,10 @@ public final class SdkManager {
                 int apiNumber;
                 String stringValue = map.get(PROP_VERSION_SDK);
                 if (stringValue == null) {
-                    if (log != null) {
-                        log.error(null,
-                                "Ignoring platform '%1$s': %2$s is missing from '%3$s'",
-                                platform.getName(), PROP_VERSION_SDK,
-                                SdkConstants.FN_BUILD_PROP);
-                    }
+                    log.error(null,
+                            "Ignoring platform '%1$s': %2$s is missing from '%3$s'",
+                            platform.getName(), PROP_VERSION_SDK,
+                            SdkConstants.FN_BUILD_PROP);
                     return null;
                 } else {
                     try {
@@ -312,12 +307,10 @@ public final class SdkManager {
                     } catch (NumberFormatException e) {
                         // looks like apiNumber does not parse to a number.
                         // Ignore this platform.
-                        if (log != null) {
-                            log.error(null,
-                                    "Ignoring platform '%1$s': %2$s is not a valid number in %3$s.",
-                                    platform.getName(), PROP_VERSION_SDK,
-                                    SdkConstants.FN_BUILD_PROP);
-                        }
+                        log.error(null,
+                                "Ignoring platform '%1$s': %2$s is not a valid number in %3$s.",
+                                platform.getName(), PROP_VERSION_SDK,
+                                SdkConstants.FN_BUILD_PROP);
                         return null;
                     }
                 }
@@ -371,7 +364,7 @@ public final class SdkManager {
 
                 return target;
             }
-        } else if (log != null) {
+        } else {
             log.error(null, "Ignoring platform '%1$s': %2$s is missing.", platform.getName(),
                     SdkConstants.FN_BUILD_PROP);
         }
@@ -384,7 +377,7 @@ public final class SdkManager {
      * Loads the Add-on from the SDK.
      * @param location Location of the SDK
      * @param list the list to fill with the add-ons.
-     * @param log the ISdkLog object receiving warning/error from the parsing.
+     * @param log the ISdkLog object receiving warning/error from the parsing. Cannot be null.
      */
     private static void loadAddOns(String location, ArrayList<IAndroidTarget> list, ISdkLog log) {
         File addonFolder = new File(location, SdkConstants.FD_ADDONS);
@@ -419,7 +412,7 @@ public final class SdkManager {
      * Loads a specific Add-on at a given location.
      * @param addon the location of the addon.
      * @param targetList The list of Android target that were already loaded from the SDK.
-     * @param log the ISdkLog object receiving warning/error from the parsing.
+     * @param log the ISdkLog object receiving warning/error from the parsing. Cannot be null.
      */
     private static AddOnTarget loadAddon(File addon, ArrayList<IAndroidTarget> targetList,
             ISdkLog log) {
@@ -459,11 +452,9 @@ public final class SdkManager {
 
                     if (baseTarget == null) {
                         // Ignore this add-on.
-                        if (log != null) {
-                            log.error(null,
-                                    "Ignoring add-on '%1$s': Unable to find base platform with API level '%2$s'",
-                                    addon.getName(), api);
-                        }
+                        log.error(null,
+                                "Ignoring add-on '%1$s': Unable to find base platform with API level '%2$s'",
+                                addon.getName(), api);
                         return null;
                     }
                 }
@@ -483,11 +474,9 @@ public final class SdkManager {
                     } catch (NumberFormatException e) {
                         // looks like apiNumber does not parse to a number.
                         // Ignore this add-on.
-                        if (log != null) {
-                            log.error(null,
-                                    "Ignoring add-on '%1$s': %2$s is not a valid number in %3$s.",
-                                    addon.getName(), ADDON_REVISION, SdkConstants.FN_BUILD_PROP);
-                        }
+                        log.error(null,
+                                "Ignoring add-on '%1$s': %2$s is not a valid number in %3$s.",
+                                addon.getName(), ADDON_REVISION, SdkConstants.FN_BUILD_PROP);
                         return null;
                     }
                 }
@@ -515,12 +504,12 @@ public final class SdkManager {
                                     if (m.matches()) {
                                         libMap.put(libName, new String[] {
                                                 m.group(1), m.group(2) });
-                                    } else if (log != null) {
+                                    } else {
                                         log.error(null,
                                                 "Ignoring library '%1$s', property value has wrong format\n\t%2$s",
                                                 libName, libData);
                                     }
-                                } else if (log != null) {
+                                } else {
                                     log.error(null,
                                             "Ignoring library '%1$s', missing property value",
                                             libName, libData);
@@ -556,7 +545,7 @@ public final class SdkManager {
 
                 return target;
             }
-        } else if (log != null) {
+        } else {
             log.error(null, "Ignoring add-on '%1$s': %2$s is missing.", addon.getName(),
                     SdkConstants.FN_MANIFEST_INI);
         }
@@ -585,11 +574,16 @@ public final class SdkManager {
         return IAndroidTarget.NO_USB_ID;
     }
 
+    /**
+     * Displays an error in the log about the addon being ignored due to a missing manifest value.
+     *
+     * @param log The logger object. Cannot be null.
+     * @param addonName The addon name, for display.
+     * @param valueName The missing manifest value, for display.
+     */
     private static void displayAddonManifestError(ISdkLog log, String addonName, String valueName) {
-        if (log != null) {
-            log.error(null, "Ignoring add-on '%1$s': '%2$s' is missing from %3$s.",
-                    addonName, valueName, SdkConstants.FN_MANIFEST_INI);
-        }
+        log.error(null, "Ignoring add-on '%1$s': '%2$s' is missing from %3$s.",
+                addonName, valueName, SdkConstants.FN_MANIFEST_INI);
     }
 
     /**
@@ -597,11 +591,14 @@ public final class SdkManager {
      * present.
      * <p/>This checks the presence of the following files: android.jar, framework.aidl, aapt(.exe),
      * aidl(.exe), dx(.bat), and dx.jar
+     *
+     * @param platform The folder containing the platform.
+     * @param log Logger. Cannot be null.
      */
     private static boolean checkPlatformContent(File platform, ISdkLog log) {
         for (String relativePath : sPlatformContentList) {
             File f = new File(platform, relativePath);
-            if (!f.exists() && log != null) {
+            if (!f.exists()) {
                 log.error(null,
                         "Ignoring platform '%1$s': %2$s is missing.",
                         platform.getName(), relativePath);
@@ -615,8 +612,9 @@ public final class SdkManager {
     /**
      * Parses a property file (using UTF-8 encoding) and returns a map of the content.
      * <p/>If the file is not present, null is returned with no error messages sent to the log.
+     *
      * @param propFile the property file to parse
-     * @param log the ISdkLog object receiving warning/error from the parsing.
+     * @param log the ISdkLog object receiving warning/error from the parsing. Cannot be null.
      * @return the map of (key,value) pairs, or null if the parsing failed.
      */
     public static Map<String, String> parsePropertyFile(File propFile, ISdkLog log) {
@@ -635,10 +633,9 @@ public final class SdkManager {
                     if (m.matches()) {
                         map.put(m.group(1), m.group(2));
                     } else {
-                        if (log != null) {
-                            log.warning("Error parsing '%1$s': \"%2$s\" is not a valid syntax",
-                                    propFile.getAbsolutePath(), line);
-                        }
+                        log.warning("Error parsing '%1$s': \"%2$s\" is not a valid syntax",
+                                propFile.getAbsolutePath(),
+                                line);
                         return null;
                     }
                 }
@@ -650,10 +647,9 @@ public final class SdkManager {
             // calling the method.
             // Return null below.
         } catch (IOException e) {
-            if (log != null) {
-                log.warning("Error parsing '%1$s': %2$s.", propFile.getAbsolutePath(),
-                        e.getMessage());
-            }
+            log.warning("Error parsing '%1$s': %2$s.",
+                    propFile.getAbsolutePath(),
+                    e.getMessage());
         } finally {
             if (reader != null) {
                 try {
@@ -705,6 +701,11 @@ public final class SdkManager {
         return new String[0];
     }
 
+    /**
+     * Loads all samples from the {@link SdkConstants#FD_SAMPLES} directory.
+     *
+     * @param log Logger. Cannot be null.
+     */
     private void loadSamples(ISdkLog log) {
         File sampleFolder = new File(mSdkLocation, SdkConstants.FD_SAMPLES);
         if (sampleFolder.isDirectory()) {
@@ -729,6 +730,13 @@ public final class SdkManager {
         }
     }
 
+    /**
+     * Returns the {@link AndroidVersion} of the sample in the given folder.
+     *
+     * @param folder The sample's folder.
+     * @param log Logger for errors. Cannot be null.
+     * @return An {@link AndroidVersion} or null on error.
+     */
     private AndroidVersion getSamplesVersion(File folder, ISdkLog log) {
         File sourceProp = new File(folder, SdkConstants.FN_SOURCE_PROP);
         try {

diff --git a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/avd/AvdManager.java b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/avd/AvdManager.java
index 986d760..4fdc7d5 100644 (file)
--- a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/avd/AvdManager.java
+++ b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/avd/AvdManager.java
@@ -357,7 +357,7 @@ public final class AvdManager {
      *            This log object is not kept by this instance of AvdManager and each
      *            method takes its own logger. The rationale is that the AvdManager
      *            might be called from a variety of context, each with different
-     *            logging needs.
+     *            logging needs. Cannot be null.
      * @throws AndroidLocationException
      */
     public AvdManager(SdkManager sdkManager, ISdkLog log) throws AndroidLocationException {
@@ -1118,9 +1118,7 @@ public final class AvdManager {
 
         if (configIniFile != null) {
             if (!configIniFile.isFile()) {
-                if (log != null) {
-                    log.warning("Missing file '%1$s'.",  configIniFile.getPath());
-                }
+                log.warning("Missing file '%1$s'.",  configIniFile.getPath());
             } else {
                 properties = SdkManager.parsePropertyFile(configIniFile, log);
             }

diff --git a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/avd/HardwareProperties.java b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/avd/HardwareProperties.java
index 77142b1..7d29364 100644 (file)
--- a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/avd/HardwareProperties.java
+++ b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/avd/HardwareProperties.java
@@ -102,7 +102,7 @@ public class HardwareProperties {
     /**
      * Parses the hardware definition file.
      * @param file the property file to parse
-     * @param log the ISdkLog object receiving warning/error from the parsing.
+     * @param log the ISdkLog object receiving warning/error from the parsing. Cannot be null.
      * @return the map of (key,value) pairs, or null if the parsing failed.
      */
     public static Map<String, HardwareProperty> parseHardwareDefinitions(File file, ISdkLog log) {
@@ -156,10 +156,8 @@ public class HardwareProperties {
             // calling the method.
             // Return null below.
         } catch (IOException e) {
-            if (log != null) {
-                log.warning("Error parsing '%1$s': %2$s.", file.getAbsolutePath(),
+            log.warning("Error parsing '%1$s': %2$s.", file.getAbsolutePath(),
                         e.getMessage());
-            }
         }
 
         return null;

diff --git a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/project/ProjectCreator.java b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/project/ProjectCreator.java
index 9fe5bba..4165b5d 100644 (file)
--- a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/project/ProjectCreator.java
+++ b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/project/ProjectCreator.java
@@ -128,12 +128,23 @@ public class ProjectCreator {
         }
     }
 
+    /** The {@link OutputLevel} verbosity. */
     private final OutputLevel mLevel;
-
+    /** Logger for errors and output. Cannot be null. */
     private final ISdkLog mLog;
+    /** The OS path of the SDK folder. */
     private final String mSdkFolder;
+    /** The {@link SdkManager} instance. */
     private final SdkManager mSdkManager;
 
+    /**
+     * Helper class to create android projects.
+     *
+     * @param sdkManager The {@link SdkManager} instance.
+     * @param sdkFolder The OS path of the SDK folder.
+     * @param level The {@link OutputLevel} verbosity.
+     * @param log Logger for errors and output. Cannot be null.
+     */
     public ProjectCreator(SdkManager sdkManager, String sdkFolder, OutputLevel level, ISdkLog log) {
         mSdkManager = sdkManager;
         mSdkFolder = sdkFolder;

diff --git a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/repository/LocalSdkParser.java b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/repository/LocalSdkParser.java
index d20a81b..ebcc0fb 100755 (executable)
--- a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/repository/LocalSdkParser.java
+++ b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/repository/LocalSdkParser.java
@@ -70,7 +70,7 @@ public class LocalSdkParser {
      *\r
      * @param osSdkRoot The path to the SDK folder.\r
      * @param sdkManager An existing SDK manager to list current platforms and addons.\r
-     * @param log An SDK logger object.\r
+     * @param log An SDK logger object. Cannot be null.\r
      * @return The packages found. Can be retrieved later using {@link #getPackages()}.\r
      */\r
     public Package[] parseSdk(String osSdkRoot, SdkManager sdkManager, ISdkLog log) {\r

diff --git a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/repository/RepoSources.java b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/repository/RepoSources.java
index e0452b8..9dbdaf5 100755 (executable)
--- a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/repository/RepoSources.java
+++ b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/repository/RepoSources.java
@@ -138,7 +138,7 @@ public class RepoSources {
 \r
     /**\r
      * Saves all the user sources.\r
-     * @param log\r
+     * @param log Logger. Cannot be null.\r
      */\r
     public void saveUserSources(ISdkLog log) {\r
         FileOutputStream fos = null;\r

diff --git a/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/internal/repository/UpdaterData.java b/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/internal/repository/UpdaterData.java
index c4f1714..5e40e5b 100755 (executable)
--- a/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/internal/repository/UpdaterData.java
+++ b/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/internal/repository/UpdaterData.java
@@ -70,6 +70,12 @@ class UpdaterData {
 \r
     private Shell mWindowShell;\r
 \r
+    /**\r
+     * Creates a new updater data.\r
+     *\r
+     * @param sdkLog Logger. Cannot be null.\r
+     * @param osSdkRoot The OS path to the SDK root.\r
+     */\r
     public UpdaterData(String osSdkRoot, ISdkLog sdkLog) {\r
         mOsSdkRoot = osSdkRoot;\r
         mSdkLog = sdkLog;\r

diff --git a/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/internal/repository/UpdaterWindowImpl.java b/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/internal/repository/UpdaterWindowImpl.java
index cfe8f50..4a41e4d 100755 (executable)
--- a/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/internal/repository/UpdaterWindowImpl.java
+++ b/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/internal/repository/UpdaterWindowImpl.java
@@ -77,6 +77,15 @@ public class UpdaterWindowImpl {
     private AvdManagerPage mAvdManagerPage;\r
     private StackLayout mStackLayout;\r
 \r
+    /**\r
+     * Creates a new window. Caller must call open(), which will block.\r
+     *\r
+     * @param parentShell Parent shell.\r
+     * @param sdkLog Logger. Cannot be null.\r
+     * @param osSdkRoot The OS path to the SDK root.\r
+     * @param userCanChangeSdkRoot If true, the window lets the user change the SDK path\r
+     *                             being browsed.\r
+     */\r
     public UpdaterWindowImpl(Shell parentShell, ISdkLog sdkLog, String osSdkRoot,\r
             boolean userCanChangeSdkRoot) {\r
         mParentShell = parentShell;\r

diff --git a/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/internal/widgets/AvdSelector.java b/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/internal/widgets/AvdSelector.java
index 160e2fe..2631dd0 100644 (file)
--- a/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/internal/widgets/AvdSelector.java
+++ b/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/internal/widgets/AvdSelector.java
@@ -1021,7 +1021,7 @@ public final class AvdSelector {
      * Get the stderr/stdout outputs of a process and return when the process is done.
      * Both <b>must</b> be read or the process will block on windows.
      * @param process The process to get the output from.
-     * @param monitor An {@link ISdkLog} to capture errors.
+     * @param monitor An {@link ITaskMonitor} to capture errors. Cannot be null.
      */
     private void grabEmulatorOutput(final Process process, final ITaskMonitor monitor) {
         // read the lines as they come. if null is returned, it's because the process finished

diff --git a/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/repository/UpdaterWindow.java b/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/repository/UpdaterWindow.java
index 975ae24..0e20ded 100755 (executable)
--- a/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/repository/UpdaterWindow.java
+++ b/sdkmanager/libs/sdkuilib/src/com/android/sdkuilib/repository/UpdaterWindow.java
@@ -45,7 +45,9 @@ public class UpdaterWindow {
 \r
     /**\r
      * Creates a new window. Caller must call open(), which will block.\r
-     * @param sdkLog Logger. Can be null.\r
+     *\r
+     * @param parentShell Parent shell.\r
+     * @param sdkLog Logger. Cannot be null.\r
      * @param osSdkRoot The OS path to the SDK root.\r
      * @param userCanChangeSdkRoot If true, the window lets the user change the SDK path\r
      *                             being browsed.\r