Adding a lookupAllMap method which returns the configurables and their names.

Author: Craigacp

olcut-core/src/main/java/com/oracle/labs/mlrg/olcut/config/ConfigurationManager.java

@@ -1422,6 +1422,50 @@ public <T extends Configurable> T lookup(Class<T> c, ComponentListener<T> cl) {
         return comps.get(0);
     }
 
+    /**
+     * Looks up all the components of a given type, returning a map of them.
+     * <p>
+     * If the class is an interface, it returns all the configurables which implement that interface,
+     * if it's a concrete class then it returns only those configurables which are exactly that class.
+     * @param c The class of component to lookup.
+     * @param <T> The type of the component.
+     * @return A map containing all instances of the desired class this configuration manager knows about.
+     */
+    @SuppressWarnings("unchecked") // Casts to T are implicitly checked as we use Class<T> to find the names.
+    public <T extends Configurable> Map<String, T> lookupAllMap(Class<T> c) {
+        Map<String, T> ret = new HashMap<>();
+
+        //
+        // If the class isn't an interface, then lookup each of the names
+        // in the raw property data with the given class
+        // name, ignoring those things marked as importable.
+        if(!c.isInterface()) {
+            String className = c.getName();
+            for (Map.Entry<String, ConfigurationData> e : configurationDataMap.entrySet()) {
+                if (e.getValue().getClassName().equals(className) &&
+                        !e.getValue().isImportable()) {
+                    ret.put(e.getKey(),(T)lookup(e.getKey()));
+                }
+            }
+        } else {
+            //
+            // If we have an interface and no registry, lookup all the
+            // implementing classes and return them.
+            for (Map.Entry<String, ConfigurationData> e : configurationDataMap.entrySet()) {
+                try {
+                    Class clazz = Class.forName(e.getValue().getClassName());
+                    if (!e.getValue().isImportable() && c.isAssignableFrom(clazz) && !clazz.isInterface()) {
+                        ret.put(e.getKey(),(T)innerLookup(e.getKey(),null,true));
+                    }
+                } catch (ClassNotFoundException ex) {
+                    throw new PropertyException(ex,e.getKey(),"Class not found for component " + e.getKey());
+                }
+            }
+        }
+
+        return ret;
+    }
+
     /**
      * Looks up all the components of a given type, returning a list of them.
      * @param c The class of component to lookup.

olcut-core/src/test/java/com/oracle/labs/mlrg/olcut/config/GenericConfigTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2004-2020, Oracle and/or its affiliates.
+ * Copyright (c) 2004-2021, Oracle and/or its affiliates.
  *
  * Licensed under the 2-clause BSD license.
  *
@@ -30,9 +30,15 @@
 
 import java.io.IOException;
 import java.util.List;
+import java.util.Map;
 
 import com.oracle.labs.mlrg.olcut.config.test.Ape;
+import com.oracle.labs.mlrg.olcut.config.test.Barbary;
+import com.oracle.labs.mlrg.olcut.config.test.Chimp;
+import com.oracle.labs.mlrg.olcut.config.test.Gorilla;
 import com.oracle.labs.mlrg.olcut.config.test.Monkey;
+import com.oracle.labs.mlrg.olcut.config.test.Orangutan;
+import com.oracle.labs.mlrg.olcut.config.test.Rhesus;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.*;
@@ -58,6 +64,41 @@ public void lookupAllTest() throws ClassNotFoundException {
         assertEquals(3, apes.size(), "Didn't find all the Ape classes");
     }
 
+    @SuppressWarnings("unchecked")//Looking up a specific class via it's full name
+    @Test
+    public void lookupAllMapTest() throws ClassNotFoundException {
+        ConfigurationManager cm = new ConfigurationManager("genericConfig.xml");
+
+        Class<Monkey> clazz = (Class<Monkey>) Class.forName("com.oracle.labs.mlrg.olcut.config.test.Monkey");
+        Map<String,Monkey> monkeys = cm.lookupAllMap(clazz);
+
+        assertEquals(5, monkeys.size(), "Didn't find all the MonkeyConfigurable classes");
+        assertTrue(monkeys.get("monkey-one") instanceof Gorilla);
+        assertTrue(monkeys.get("monkey-two") instanceof Chimp);
+        assertTrue(monkeys.get("monkey-three") instanceof Orangutan);
+        assertTrue(monkeys.get("monkey-four") instanceof Rhesus);
+        assertTrue(monkeys.get("monkey-five") instanceof Barbary);
+
+        Class<Ape> apeClazz = (Class<Ape>) Class.forName("com.oracle.labs.mlrg.olcut.config.test.Ape");
+        Map<String,Ape> apes = cm.lookupAllMap(apeClazz);
+
+        assertEquals(3, apes.size(), "Didn't find all the Ape classes");
+        assertTrue(apes.get("monkey-one") instanceof Gorilla);
+        assertTrue(apes.get("monkey-two") instanceof Chimp);
+        assertTrue(apes.get("monkey-three") instanceof Orangutan);
+
+        Class<Gorilla> gorillaClazz = (Class<Gorilla>) Class.forName("com.oracle.labs.mlrg.olcut.config.test.Gorilla");
+        Map<String,Gorilla> gorillas = cm.lookupAllMap(gorillaClazz);
+
+        assertEquals(1,gorillas.size(),"Didn't find the Gorilla instance");
+        assertTrue(gorillas.get("monkey-one") instanceof Gorilla);
+
+        Class<ArrayStringConfigurable> arrStrConfClazz = (Class<ArrayStringConfigurable>) Class.forName("com.oracle.labs.mlrg.olcut.config.ArrayStringConfigurable");
+        Map<String,ArrayStringConfigurable> arrays = cm.lookupAllMap(arrStrConfClazz);
+
+        assertTrue(arrays.isEmpty());
+    }
+
     @Test
     public void correctListConfig() throws IOException {
         ConfigurationManager cm = new ConfigurationManager("genericConfig.xml");