Adding librarydescriptor to api class

Author: jantje

io.sloeber.core/src/io/sloeber/core/api/IInstallLibraryHandler.java

@@ -2,8 +2,6 @@
 
 import java.util.Map;
 
-import io.sloeber.core.managers.Library;
-
 /**
  * this interface is to allow the ui to handle the automatic installation
  * of libraries.
@@ -31,5 +29,5 @@ public interface  IInstallLibraryHandler {
   *
   * @return The libraries the user wants to install
   */
- abstract Map<String, Library> selectLibrariesToInstall(Map<String, Library> proposedLibsToInstall);
+ abstract Map<String, LibraryDescriptor> selectLibrariesToInstall(Map<String, LibraryDescriptor> proposedLibsToInstall);
 }

io.sloeber.core/src/io/sloeber/core/api/LibraryDescriptor.java

@@ -0,0 +1,17 @@
+package io.sloeber.core.api;
+
+import io.sloeber.core.managers.Library;
+
+public class LibraryDescriptor {
+	private Library library=null;
+
+	public LibraryDescriptor(Library value) {
+		this.library=value;
+	}
+
+	public Library toLibrary() {
+		// TODO Auto-generated method stub
+		return this.library;
+	}
+
+}

io.sloeber.core/src/io/sloeber/core/api/LibraryManager.java

@@ -32,7 +32,16 @@
 import io.sloeber.core.managers.Manager;
 import io.sloeber.core.managers.Messages;
 import io.sloeber.core.tools.Version;
-
+/**
+ * This class is the main entry point for libraries.
+ * It handles
+ *   private libraries
+ *   hardware libraries
+ *   installed libraries
+ *
+ * @author jan
+ *
+ */
 public class LibraryManager {
 	static private List<LibraryIndex> libraryIndices;
 	private static IInstallLibraryHandler myInstallLibraryHandler = new DefaultInstallHandler();
@@ -360,18 +369,18 @@ public static void removeAllLibs() {
 	 *
 	 * @return a map of all instalable libraries
 	 */
-	public static Map<String, io.sloeber.core.managers.Library> getAllInstallableLibraries() {
-		Map<String, Library> ret = new HashMap<>();
+	public static Map<String, LibraryDescriptor> getAllInstallableLibraries() {
+		Map<String, LibraryDescriptor> ret = new HashMap<>();
 		for (LibraryIndex libraryIndex : libraryIndices) {
 			ret.putAll(libraryIndex.getLatestInstallableLibraries());
 		}
 
 		return ret;
 	}
 
-	public static Map<String, io.sloeber.core.managers.Library> getLatestInstallableLibraries(Set<String> libnames) {
+	public static Map<String, LibraryDescriptor> getLatestInstallableLibraries(Set<String> libnames) {
 		Set<String> remainingLibNames = new TreeSet<>(libnames);
-		Map<String, Library> ret = new HashMap<>();
+		Map<String, LibraryDescriptor> ret = new HashMap<>();
 		for (LibraryIndex libraryIndex : libraryIndices) {
 			ret.putAll(libraryIndex.getLatestInstallableLibraries(remainingLibNames));
 			remainingLibNames.removeAll(ret.keySet());

io.sloeber.core/src/io/sloeber/core/core/DefaultInstallHandler.java

@@ -3,7 +3,7 @@
 import java.util.Map;
 
 import io.sloeber.core.api.IInstallLibraryHandler;
-import io.sloeber.core.managers.Library;
+import io.sloeber.core.api.LibraryDescriptor;
 
 public class DefaultInstallHandler implements IInstallLibraryHandler {
 
@@ -14,7 +14,7 @@ public boolean autoInstall() {
 
 
 	@Override
-	public Map<String, Library> selectLibrariesToInstall(Map<String, Library> proposedLibsToInstall) {
+	public Map<String, LibraryDescriptor> selectLibrariesToInstall(Map<String, LibraryDescriptor> proposedLibsToInstall) {
 
 		return proposedLibsToInstall;
 	}

io.sloeber.core/src/io/sloeber/core/managers/LibraryIndex.java

@@ -12,8 +12,15 @@
 import java.util.regex.Pattern;
 
 import io.sloeber.core.api.Defaults;
+import io.sloeber.core.api.LibraryDescriptor;
 import io.sloeber.core.tools.Version;
 
+/**
+ * This class represents a json file that references libraries
+ *
+ * @author jan
+ *
+ */
 public class LibraryIndex {
 	private String jsonFileName;
 	private List<Library> libraries;
@@ -101,11 +108,11 @@ public Map<String, Library> getLatestLibraries() {
 	 *
 	 * @return
 	 */
-	public Map<String, Library> getLatestInstallableLibraries() {
-		Map<String, Library> ret = new HashMap<>();
+	public Map<String, LibraryDescriptor> getLatestInstallableLibraries() {
+		Map<String, LibraryDescriptor> ret = new HashMap<>();
 		for (Entry<String, Library> curLibrary : this.latestLibs.entrySet()) {
 			if (!curLibrary.getValue().isAVersionInstalled()) {
-				ret.put(curLibrary.getKey(), curLibrary.getValue());
+				ret.put(curLibrary.getKey(),new LibraryDescriptor( curLibrary.getValue()));
 			}
 		}
 		return ret;
@@ -147,15 +154,15 @@ public String getName() {
 	 *
 	 * @return
 	 */
-	public Map<String, Library> getLatestInstallableLibraries(Set<String> libNames) {
-		Map<String, Library> ret = new HashMap<>();
+	public Map<String, LibraryDescriptor> getLatestInstallableLibraries(Set<String> libNames) {
+		Map<String, LibraryDescriptor> ret = new HashMap<>();
 		if (libNames.isEmpty()) {
 			return ret;
 		}
 		for (Entry<String, Library> curLibrary : this.latestLibs.entrySet()) {
 			if (libNames.contains(curLibrary.getKey())) {
 				if (!curLibrary.getValue().isAVersionInstalled()) {
-					ret.put(curLibrary.getKey(), curLibrary.getValue());
+					ret.put(curLibrary.getKey(), new LibraryDescriptor(curLibrary.getValue()));
 				}
 			}
 		}

io.sloeber.core/src/io/sloeber/core/tools/Libraries.java

@@ -37,6 +37,7 @@
 import io.sloeber.core.InternalBoardDescriptor;
 import io.sloeber.core.api.BoardDescriptor;
 import io.sloeber.core.api.IInstallLibraryHandler;
+import io.sloeber.core.api.LibraryDescriptor;
 import io.sloeber.core.api.LibraryManager;
 import io.sloeber.core.common.Common;
 import io.sloeber.core.common.ConfigurationPreferences;
@@ -404,15 +405,15 @@ public static void checkLibraries(IProject affectedProject) {
 					if(!uninstalledIncludedHeaders.isEmpty()) {
 						//some libraries may need to be installed
 
-						Map<String, Library>	availableLibs=LibraryManager.getLatestInstallableLibraries(uninstalledIncludedHeaders);
+						Map<String, LibraryDescriptor>	availableLibs=LibraryManager.getLatestInstallableLibraries(uninstalledIncludedHeaders);
 
 						if(!availableLibs.isEmpty()) {
 							//We now know which libraries to install
 							//TODO for now I just install but there should be some user
 							//interaction
 							availableLibs=installHandler.selectLibrariesToInstall(availableLibs);
-							for (Entry<String, Library> curLib : availableLibs.entrySet()) {
-								curLib.getValue().install(new NullProgressMonitor());
+							for (Entry<String, LibraryDescriptor> curLib : availableLibs.entrySet()) {
+								curLib.getValue().toLibrary().install(new NullProgressMonitor());
 							}
 						}
 					}

io.sloeber.ui/src/io/sloeber/ui/listeners/MyLibraryInstallHandler.java

@@ -0,0 +1,22 @@
+package io.sloeber.ui.listeners;
+
+import java.util.Map;
+
+import io.sloeber.core.api.IInstallLibraryHandler;
+import io.sloeber.core.api.LibraryDescriptor;
+
+public class MyLibraryInstallHandler implements IInstallLibraryHandler {
+
+	@Override
+	public boolean autoInstall() {
+		// TODO Auto-generated method stub
+		return true;
+	}
+
+	@Override
+	public Map<String, LibraryDescriptor> selectLibrariesToInstall(Map<String, LibraryDescriptor> proposedLibsToInstall) {
+		// TODO Auto-generated method stub
+		return proposedLibsToInstall;
+	}
+
+}