You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by io...@apache.org on 2011/11/29 18:23:58 UTC

svn commit: r1207980 - in /karaf/branches/karaf-2.2.x: admin/command/src/main/java/org/apache/karaf/admin/command/ admin/command/src/main/resources/OSGI-INF/blueprint/ shell/console/src/main/java/org/apache/felix/gogo/commands/ shell/console/src/main/j...

Author: iocanel
Date: Tue Nov 29 17:23:57 2011
New Revision: 1207980

URL: http://svn.apache.org/viewvc?rev=1207980&view=rev
Log:
[KARAF-1029] Removed the completer property from the Option annotation and used a map for optional completers, in order to provide more control on the completer to use.


Conflicts:

	shell/console/src/main/java/org/apache/karaf/shell/console/commands/NamespaceHandler.java

Modified:
    karaf/branches/karaf-2.2.x/admin/command/src/main/java/org/apache/karaf/admin/command/CreateCommand.java
    karaf/branches/karaf-2.2.x/admin/command/src/main/resources/OSGI-INF/blueprint/admin-command.xml
    karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/felix/gogo/commands/Option.java
    karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/felix/gogo/commands/basic/DefaultActionPreparator.java
    karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/CompletableFunction.java
    karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/commands/BlueprintCommand.java
    karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/commands/NamespaceHandler.java
    karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/completer/ArgumentCompleter.java
    karaf/branches/karaf-2.2.x/shell/console/src/main/resources/org/apache/karaf/shell/console/commands/karaf-shell-1.1.0.xsd
    karaf/branches/karaf-2.2.x/shell/console/src/test/java/org/apache/karaf/shell/console/completer/ArgumentCompleterTest.java

Modified: karaf/branches/karaf-2.2.x/admin/command/src/main/java/org/apache/karaf/admin/command/CreateCommand.java
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/admin/command/src/main/java/org/apache/karaf/admin/command/CreateCommand.java?rev=1207980&r1=1207979&r2=1207980&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/admin/command/src/main/java/org/apache/karaf/admin/command/CreateCommand.java (original)
+++ karaf/branches/karaf-2.2.x/admin/command/src/main/java/org/apache/karaf/admin/command/CreateCommand.java Tue Nov 29 17:23:57 2011
@@ -50,13 +50,11 @@ public class CreateCommand extends Admin
     String javaOpts;
     
     @Option(name = "-f", aliases = {"--feature"},
-            description = "Initial features. This option can be specified multiple times to enable multiple initial features", required = false, multiValued = true,
-            completer = AllFeatureCompleter.class)
+            description = "Initial features. This option can be specified multiple times to enable multiple initial features", required = false, multiValued = true)
     List<String> features;
     
     @Option(name = "-furl", aliases = {"--featureURL"}, 
-            description = "Additional feature descriptor URLs. This option can be specified multiple times to add multiple URLs", required = false, multiValued = true,
-            completer = FeatureRepositoryCompleter.class)
+            description = "Additional feature descriptor URLs. This option can be specified multiple times to add multiple URLs", required = false, multiValued = true)
     List<String> featureURLs;
 
     @Argument(index = 0, name = "name", description="The name of the new container instance", required = true, multiValued = false)

Modified: karaf/branches/karaf-2.2.x/admin/command/src/main/resources/OSGI-INF/blueprint/admin-command.xml
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/admin/command/src/main/resources/OSGI-INF/blueprint/admin-command.xml?rev=1207980&r1=1207979&r2=1207980&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/admin/command/src/main/resources/OSGI-INF/blueprint/admin-command.xml (original)
+++ karaf/branches/karaf-2.2.x/admin/command/src/main/resources/OSGI-INF/blueprint/admin-command.xml Tue Nov 29 17:23:57 2011
@@ -26,8 +26,8 @@
                 <property name="adminService" ref="adminService" />
             </action>
             <optional-completers>
-                <ref component-id="allFeatureCompleter"/>
-                <ref component-id="featureUrlCompleter"/>
+                   <entry key="-f" value-ref="allFeatureCompleter"/>
+                   <entry key="-furl" value-ref="featureUrlCompleter"/>
             </optional-completers>
         </command>
         <command name="admin/connect">

Modified: karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/felix/gogo/commands/Option.java
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/felix/gogo/commands/Option.java?rev=1207980&r1=1207979&r2=1207980&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/felix/gogo/commands/Option.java (original)
+++ karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/felix/gogo/commands/Option.java Tue Nov 29 17:23:57 2011
@@ -22,8 +22,6 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 import java.lang.annotation.ElementType;
-import org.apache.karaf.shell.console.Completer;
-import org.apache.karaf.shell.console.completer.NullCompleter;
 
 /**
  * Used to mark an optional named command line option who's name typically starts with "--"
@@ -44,7 +42,5 @@ public @interface Option
 
     boolean multiValued() default false;
 
-    Class<? extends Completer> completer() default NullCompleter.class;
-
     String valueToShowInHelp() default DEFAULT_STRING;
 }

Modified: karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/felix/gogo/commands/basic/DefaultActionPreparator.java
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/felix/gogo/commands/basic/DefaultActionPreparator.java?rev=1207980&r1=1207979&r2=1207980&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/felix/gogo/commands/basic/DefaultActionPreparator.java (original)
+++ karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/felix/gogo/commands/basic/DefaultActionPreparator.java Tue Nov 29 17:23:57 2011
@@ -41,7 +41,6 @@ import org.apache.felix.gogo.commands.co
 import org.apache.felix.gogo.commands.converter.GenericType;
 import org.apache.felix.service.command.CommandSession;
 import org.apache.karaf.shell.console.NameScoping;
-import org.apache.karaf.shell.console.completer.NullCompleter;
 import org.fusesource.jansi.Ansi;
 
 public class DefaultActionPreparator implements ActionPreparator {
@@ -81,11 +80,6 @@ public class DefaultActionPreparator imp
         {
             return Option.class;
         }
-
-        @Override
-        public Class completer() {
-            return NullCompleter.class;
-        }
     };
 
     public boolean prepare(Action action, CommandSession session, List<Object> params) throws Exception

Modified: karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/CompletableFunction.java
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/CompletableFunction.java?rev=1207980&r1=1207979&r2=1207980&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/CompletableFunction.java (original)
+++ karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/CompletableFunction.java Tue Nov 29 17:23:57 2011
@@ -19,12 +19,13 @@
 package org.apache.karaf.shell.console;
 
 import java.util.List;
+import java.util.Map;
 
 import org.apache.felix.service.command.Function;
 
 public interface CompletableFunction extends Function {
 
     List<Completer> getCompleters();
-    List<Completer> getOptionalCompleters();
+    Map<String, Completer> getOptionalCompleters();
 
 }

Modified: karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/commands/BlueprintCommand.java
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/commands/BlueprintCommand.java?rev=1207980&r1=1207979&r2=1207980&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/commands/BlueprintCommand.java (original)
+++ karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/commands/BlueprintCommand.java Tue Nov 29 17:23:57 2011
@@ -19,6 +19,7 @@ package org.apache.karaf.shell.console.c
 
 import java.lang.reflect.Type;
 import java.util.List;
+import java.util.Map;
 
 import org.apache.felix.gogo.commands.Action;
 import org.apache.felix.gogo.commands.basic.AbstractCommand;
@@ -33,14 +34,15 @@ import org.osgi.framework.BundleContext;
 import org.osgi.service.blueprint.container.BlueprintContainer;
 import org.osgi.service.blueprint.container.Converter;
 
-public class BlueprintCommand extends AbstractCommand implements CompletableFunction
+public class
+        BlueprintCommand extends AbstractCommand implements CompletableFunction
 {
 
     protected BlueprintContainer blueprintContainer;
     protected Converter blueprintConverter;
     protected String actionId;
     protected List<Completer> completers;
-    protected List<Completer> optionalCompleters;
+    protected Map<String,Completer> optionalCompleters;
 
     public void setBlueprintContainer(BlueprintContainer blueprintContainer) {
         this.blueprintContainer = blueprintContainer;
@@ -62,11 +64,11 @@ public class BlueprintCommand extends Ab
         this.completers = completers;
     }
 
-    public List<Completer> getOptionalCompleters() {
+    public Map<String, Completer> getOptionalCompleters() {
         return optionalCompleters;
     }
 
-    public void setOptionalCompleters(List<Completer> optionalCompleters) {
+    public void setOptionalCompleters(Map<String, Completer> optionalCompleters) {
         this.optionalCompleters = optionalCompleters;
     }
 

Modified: karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/commands/NamespaceHandler.java
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/commands/NamespaceHandler.java?rev=1207980&r1=1207979&r2=1207980&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/commands/NamespaceHandler.java (original)
+++ karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/commands/NamespaceHandler.java Tue Nov 29 17:23:57 2011
@@ -55,6 +55,7 @@ public class NamespaceHandler implements
     public static final String BEAN = "bean";
     public static final String REF = "ref";
     public static final String NULL = "null";
+    public static final String MAP = "map";
     public static final String BLUEPRINT_CONTAINER = "blueprintContainer";
     public static final String BLUEPRINT_CONVERTER = "blueprintConverter";
 
@@ -135,7 +136,7 @@ public class NamespaceHandler implements
                 } else if (nodeNameEquals(childElement, COMPLETERS)) {
                     command.addProperty(COMPLETERS, parseCompleters(context, command, childElement));
                 } else if (nodeNameEquals(childElement, OPTIONAL_COMPLETERS)) {
-                    command.addProperty(OPTIONAL_COMPLETERS_PROPERTY, parseCompleters(context, command, childElement));
+                    command.addProperty(OPTIONAL_COMPLETERS_PROPERTY, parseOptionalCompleters(context, command, childElement));
                 }
                 else {
                     throw new ComponentDefinitionException("Bad xml syntax: unknown element '" + childElement.getNodeName() + "'");
@@ -177,12 +178,17 @@ public class NamespaceHandler implements
         return action;
     }
 
+    private Metadata parseOptionalCompleters(ParserContext context, ComponentMetadata enclosingComponent, Element element) {
+        Metadata metadata = context.parseElement(MapMetadata.class, context.getEnclosingComponent(), (Element) element);
+        return metadata;
+    }
+
     private Metadata parseCompleters(ParserContext context, ComponentMetadata enclosingComponent, Element element) {
         MutableCollectionMetadata collection = context.createMetadata(MutableCollectionMetadata.class);
         collection.setCollectionClass(List.class);
         NodeList children = element.getChildNodes();
         for (int i = 0; i < children.getLength(); i++) {
-            Node child  = children.item(i);
+            Node child = children.item(i);
             if (child instanceof Element) {
                 Metadata metadata;
                 if (nodeNameEquals(child, REF)) {

Modified: karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/completer/ArgumentCompleter.java
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/completer/ArgumentCompleter.java?rev=1207980&r1=1207979&r2=1207980&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/completer/ArgumentCompleter.java (original)
+++ karaf/branches/karaf-2.2.x/shell/console/src/main/java/org/apache/karaf/shell/console/completer/ArgumentCompleter.java Tue Nov 29 17:23:57 2011
@@ -59,7 +59,7 @@ public class ArgumentCompleter implement
     final Completer commandCompleter;
     final Completer optionsCompleter;
     final List<Completer> argsCompleters;
-    final List<Completer> optionalCompleters;
+    final Map<String, Completer> optionalCompleters;
     final AbstractCommand function;
     final Map<Option, Field> fields = new HashMap<Option, Field>();
     final Map<String, Option> options = new HashMap<String, Option>();
@@ -111,7 +111,7 @@ public class ArgumentCompleter implement
                 argsCompleters.add(NullCompleter.INSTANCE);
             }
         } else {
-            optionalCompleters = new ArrayList<Completer>();
+            optionalCompleters = new HashMap<String, Completer>();
             final Map<Integer, Method> methods = new HashMap<Integer, Method>();
             for (Class type = function.getActionClass(); type != null; type = type.getSuperclass()) {
                 for (Method method : type.getDeclaredMethods()) {
@@ -264,13 +264,22 @@ public class ArgumentCompleter implement
                 Field lastField = fields.get(lastOption);
                 if (lastField != null && lastField.getType() != boolean.class && lastField.getType() != Boolean.class) {
                     Option option = lastField.getAnnotation(Option.class);
-                    if (option != null && option.completer() != null) {
-                        Class<? extends Completer> type = option.completer();
-                        for (Completer optionValueCompleter : optionalCompleters) {
-                            if (optionValueCompleter.getClass().equals(type)) {
-                                comp = optionValueCompleter;
+                    if (option != null) {
+                        Completer optionValueCompleter = null;
+                        String name = option.name();
+                        optionValueCompleter = optionalCompleters.get(name);
+                        if(optionValueCompleter == null) {
+                            String[] aliases = option.aliases();
+                            if(aliases.length > 0 ) {
+                                for(int i=0; i < aliases.length && optionValueCompleter == null; i++) {
+                                    optionValueCompleter = optionalCompleters.get(option.aliases()[i]);
+                                }
                             }
                         }
+
+                        if(optionValueCompleter != null) {
+                            comp = optionValueCompleter;
+                        }
                     }
                 }
             }

Modified: karaf/branches/karaf-2.2.x/shell/console/src/main/resources/org/apache/karaf/shell/console/commands/karaf-shell-1.1.0.xsd
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/shell/console/src/main/resources/org/apache/karaf/shell/console/commands/karaf-shell-1.1.0.xsd?rev=1207980&r1=1207979&r2=1207980&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/shell/console/src/main/resources/org/apache/karaf/shell/console/commands/karaf-shell-1.1.0.xsd (original)
+++ karaf/branches/karaf-2.2.x/shell/console/src/main/resources/org/apache/karaf/shell/console/commands/karaf-shell-1.1.0.xsd Tue Nov 29 17:23:57 2011
@@ -198,13 +198,15 @@
                     These completers are used for option value completion.
                 </xsd:documentation>
             </xsd:annotation>
-            <xsd:sequence>
-                <xsd:choice minOccurs="1" maxOccurs="unbounded">
-                    <xsd:element name="bean" type="bp:Tbean"/>
-                    <xsd:element name="ref" type="bp:Tref"/>
-                    <xsd:element name="null" type="bp:Tnull"/>
-                </xsd:choice>
-            </xsd:sequence>
+            <xsd:complexContent>
+			<xsd:extension base="bp:TtypedCollection">
+				<xsd:sequence>
+					<xsd:element name="entry" type="bp:TmapEntry" minOccurs="0"
+						maxOccurs="unbounded" />
+				</xsd:sequence>
+				<xsd:attribute name="key-type" type="bp:Ttype" />
+			</xsd:extension>
+		</xsd:complexContent>
         </xsd:complexType>
     </xsd:element>
 

Modified: karaf/branches/karaf-2.2.x/shell/console/src/test/java/org/apache/karaf/shell/console/completer/ArgumentCompleterTest.java
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/shell/console/src/test/java/org/apache/karaf/shell/console/completer/ArgumentCompleterTest.java?rev=1207980&r1=1207979&r2=1207980&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/shell/console/src/test/java/org/apache/karaf/shell/console/completer/ArgumentCompleterTest.java (original)
+++ karaf/branches/karaf-2.2.x/shell/console/src/test/java/org/apache/karaf/shell/console/completer/ArgumentCompleterTest.java Tue Nov 29 17:23:57 2011
@@ -18,7 +18,9 @@ package org.apache.karaf.shell.console.c
 
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 import org.apache.felix.gogo.commands.Action;
 import org.apache.felix.gogo.commands.Option;
@@ -86,7 +88,7 @@ public class ArgumentCompleterTest exten
     public void testCompleteOptions() throws Exception {
         CommandSession session = new DummyCommandSession();
         Completer comp = new ArgumentCompleter(session, new MyFunction(), "my:action");
-        assertEquals(Arrays.asList("--check", "--foo", "--help", "--string", "-c", "-f","-s"), complete(comp, "action -"));
+        assertEquals(Arrays.asList("--check", "--foo", "--help", "--string", "--integer", "-c", "-f","-s","-i"), complete(comp, "action -"));
         assertEquals(Arrays.asList(), complete(comp, "action --foo "));
         assertEquals(Arrays.asList("action "), complete(comp, "acti"));
         assertEquals(Arrays.asList("my:action "), complete(comp, "my:ac"));
@@ -97,7 +99,11 @@ public class ArgumentCompleterTest exten
         assertEquals(Arrays.asList("foo1 "), complete(comp, "action -f 2 --check foo1"));
         assertEquals(Arrays.asList("bar1", "bar2"), complete(comp, "action -f 2 --check foo1 "));
         assertEquals(Arrays.asList("one", "two"), complete(comp, "action -s "));
+        assertEquals(Arrays.asList("one", "two"), complete(comp, "action -string "));
         assertEquals(Arrays.asList("two "), complete(comp, "action -s t"));
+        assertEquals(Arrays.asList("1", "2"), complete(comp, "action -i "));
+        assertEquals(Arrays.asList("1", "2"), complete(comp, "action --integer "));
+        assertEquals(Arrays.asList("2 "), complete(comp, "action -i 2"));
     }
 
     public static class MyFunction extends SimpleCommand implements CompletableFunction {
@@ -111,10 +117,11 @@ public class ArgumentCompleterTest exten
             );
         }
 
-        public List<Completer> getOptionalCompleters() {
-            return Arrays.<Completer>asList(
-                    new StringsCompleter(Arrays.asList("one", "two"))
-            );
+        public Map<String,Completer> getOptionalCompleters() {
+            Map<String,Completer> completers = new HashMap<String,Completer>();
+            completers.put("-s",new StringsCompleter(Arrays.asList("one","two")));
+            completers.put("--integer",new StringsCompleter(Arrays.asList("1","2")));
+            return completers;
         }
     }
 
@@ -125,9 +132,12 @@ public class ArgumentCompleterTest exten
         @Option(name = "-c", aliases = "--check")
         boolean check;
 
-        @Option(name = "-s", aliases = "--string", completer = StringsCompleter.class)
+        @Option(name = "-s", aliases = "--string")
         String string;
 
+        @Option(name = "-i", aliases = "--int")
+        String integer;
+
         public Object execute(CommandSession session) throws Exception {
             return null;
         }