You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@aries.apache.org by li...@apache.org on 2010/05/11 22:24:37 UTC

svn commit: r943269 - in /incubator/aries/trunk/blueprint: blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/ blueprint-annotation-impl/src/main/java/org/apache/aries/blueprint/annotation/impl/ blueprint-sample-annotation/src...

Author: linsun
Date: Tue May 11 20:24:37 2010
New Revision: 943269

URL: http://svn.apache.org/viewvc?rev=943269&view=rev
Log:
[blueprint annotation] update factory method and argument annotation based on some feedback from Valentin

Added:
    incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Arg.java   (with props)
Removed:
    incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/FactoryMethod.java
Modified:
    incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Bean.java
    incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Blueprint.java
    incubator/aries/trunk/blueprint/blueprint-annotation-impl/src/main/java/org/apache/aries/blueprint/annotation/impl/BlueprintAnnotationScannerImpl.java
    incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/Account.java
    incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/AccountFactory.java
    incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/StaticAccountFactory.java

Added: incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Arg.java
URL: http://svn.apache.org/viewvc/incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Arg.java?rev=943269&view=auto
==============================================================================
--- incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Arg.java (added)
+++ incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Arg.java Tue May 11 20:24:37 2010
@@ -0,0 +1,53 @@
+/**
+ *  Licensed to the Apache Software Foundation (ASF) under one or more
+ *  contributor license agreements.  See the NOTICE file distributed with
+ *  this work for additional information regarding copyright ownership.
+ *  The ASF licenses this file to You under the Apache License, Version 2.0
+ *  (the "License"); you may not use this file except in compliance with
+ *  the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+package org.apache.aries.blueprint.annotation;
+
+
+/**
+ * used to describe argument of the bean constructor
+ * or the argument of the factory method for the bean
+ * 
+ * this is mapped to Targument for the Tbean
+ *
+ */
+public @interface Arg {
+
+    /**
+     * the value of the argument
+     */
+    String value() default "";
+    
+    /**
+     * the value of the ref attribute of the argument
+     */
+    String ref() default "";
+    
+    /**
+     * the description of the argument
+     */
+    String description() default "";
+    
+    /**
+     *  the zero-based index into the parameter list of the factory method
+     *  or constructor to be invoked for this argument. This is determined by
+     *  specifying the <code>index</code> attribute for the bean. If not
+     *  explicitly set, this will return -1 and the initial ordering is defined
+     *  by its position in the args[] list.
+     */
+    int index() default -1;
+    
+}

Propchange: incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Arg.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Arg.java
------------------------------------------------------------------------------
    svn:keywords = Date Revision

Propchange: incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Arg.java
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Modified: incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Bean.java
URL: http://svn.apache.org/viewvc/incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Bean.java?rev=943269&r1=943268&r2=943269&view=diff
==============================================================================
--- incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Bean.java (original)
+++ incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Bean.java Tue May 11 20:24:37 2010
@@ -66,5 +66,17 @@ public @interface Bean {
      * factory method for the bean.
      */
     String factoryRef() default "";
+    
+    /**
+     * the factory method in the factoryRef referred factory component
+     * @return
+     */
+    String factoryMethod() default "";
+    
+    /**
+     * arguments for the bean constructor or the factory method of the bean
+     * @return
+     */
+    Arg[] args() default {};
   
 }

Modified: incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Blueprint.java
URL: http://svn.apache.org/viewvc/incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Blueprint.java?rev=943269&r1=943268&r2=943269&view=diff
==============================================================================
--- incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Blueprint.java (original)
+++ incubator/aries/trunk/blueprint/blueprint-annotation-api/src/main/java/org/apache/aries/blueprint/annotation/Blueprint.java Tue May 11 20:24:37 2010
@@ -23,6 +23,7 @@ import java.lang.annotation.Target;
 
 /**
  * this is really bundle level declaration
+ * It is possible we want to eliminate this annotation and move the configuration to the bundle manifest header.
  *
  */
 @Target(ElementType.TYPE)

Modified: incubator/aries/trunk/blueprint/blueprint-annotation-impl/src/main/java/org/apache/aries/blueprint/annotation/impl/BlueprintAnnotationScannerImpl.java
URL: http://svn.apache.org/viewvc/incubator/aries/trunk/blueprint/blueprint-annotation-impl/src/main/java/org/apache/aries/blueprint/annotation/impl/BlueprintAnnotationScannerImpl.java?rev=943269&r1=943268&r2=943269&view=diff
==============================================================================
--- incubator/aries/trunk/blueprint/blueprint-annotation-impl/src/main/java/org/apache/aries/blueprint/annotation/impl/BlueprintAnnotationScannerImpl.java (original)
+++ incubator/aries/trunk/blueprint/blueprint-annotation-impl/src/main/java/org/apache/aries/blueprint/annotation/impl/BlueprintAnnotationScannerImpl.java Tue May 11 20:24:37 2010
@@ -31,10 +31,10 @@ import javax.xml.bind.JAXBContext;
 import javax.xml.bind.JAXBException;
 import javax.xml.bind.Marshaller;
 
+import org.apache.aries.blueprint.annotation.Arg;
 import org.apache.aries.blueprint.annotation.Bean;
 import org.apache.aries.blueprint.annotation.Blueprint;
 import org.apache.aries.blueprint.annotation.Destroy;
-import org.apache.aries.blueprint.annotation.FactoryMethod;
 import org.apache.aries.blueprint.annotation.Init;
 import org.apache.aries.blueprint.annotation.Inject;
 import org.apache.aries.blueprint.annotation.Reference;
@@ -232,8 +232,33 @@ public class BlueprintAnnotationScannerI
                 }
             }
             
+            // process factory ref
+            String factoryRef = bean.factoryRef();
+            if (factoryRef.length() > 0) {
+                tbean.setFactoryRef(factoryRef);
+            }
+            
+            // process factory method
+            String factoryMethod = bean.factoryMethod();
+            if (factoryMethod.length() > 0) {
+                tbean.setFactoryMethod(factoryMethod);
+            }
+            
+
             List<Object> props = tbean.getArgumentOrPropertyOrAny();
 
+            // process args 
+            Arg[] args = bean.args();
+            
+            if (args.length > 0) {
+                for (int i = 0; i < args.length; i++) {
+                    Targument targ = createTargument(args[i]);
+                    if (targ != null) {
+                        props.add(targ);
+                    }
+                }
+            }
+            
             Field[] fields = clazz.getDeclaredFields();
             for (int i = 0; i < fields.length; i++) {
                 if (fields[i].isAnnotationPresent(Inject.class)) {          
@@ -242,7 +267,7 @@ public class BlueprintAnnotationScannerI
                 }
             }
                     
-            // check if the bean also declares init, destroy or inject or factoryMethod annotation on methods
+            // check if the bean also declares init, destroy or inject annotation on methods
             Method[] methods = clazz.getDeclaredMethods();
             for (int i = 0; i < methods.length; i++) {
                 if (methods[i].isAnnotationPresent(Init.class)) {
@@ -252,41 +277,11 @@ public class BlueprintAnnotationScannerI
                 } else if (methods[i].isAnnotationPresent(Inject.class)) {
                     String propertyName = convertFromMethodName(methods[i].getName());
                     Tproperty tp = createTproperty(propertyName, methods[i].getAnnotation(Inject.class));
-                    props.add(tp);
-                } else if (methods[i].isAnnotationPresent(FactoryMethod.class)) {
-                    FactoryMethod fm = (FactoryMethod)methods[i].getAnnotation(FactoryMethod.class);
-                    tbean.setFactoryMethod(methods[i].getName());
-                    String[] values = fm.values();
-                    for (int j = 0; j < fm.values().length; j++) {
-                        Targument targument = new Targument();
-                        targument.setValueAttribute(fm.values()[j]);
-                        props.add(targument);
-                    }
-                    
-                    
-                    
+                    props.add(tp);     
+                } else if (methods[i].isAnnotationPresent(Arg.class)) {
+                    Targument targ = createTargument(methods[i].getAnnotation(Arg.class));
+                    props.add(targ);     
                 }
-                
-            }
-            
-            // check if the bean also declared inject annotation on constructors
-            Constructor[] constructors = clazz.getConstructors();
-            for (int i = 0; i < constructors.length; i++) {
-                if (constructors[i].isAnnotationPresent(Inject.class)) {
-                    Inject inj = (Inject)constructors[i].getAnnotation(Inject.class);
-                    
-                    if (inj.value().length() > 0) {
-                        Targument targument = new Targument();
-                        targument.setValueAttribute(inj.value());
-                        props.add(targument);
-                    } else if (inj.values().length > 0) {
-                        for (int j = 0; j < inj.values().length; j++) {
-                            Targument targument = new Targument();
-                            targument.setValueAttribute(inj.values()[j]);
-                            props.add(targument);
-                        }
-                    }
-                } 
             }
             
             // check if the bean also declares service
@@ -319,6 +314,27 @@ public class BlueprintAnnotationScannerI
         return tblueprint;
     }
 
+    private Targument createTargument(Arg arg) {
+        String value = arg.value();
+        String ref = arg.ref();
+        Targument targ = null;
+        if (value.length() > 0) {
+            targ = new Targument();
+            targ.setValueAttribute(value);
+        }
+        
+        if (ref.length() > 0) {
+            if (targ == null) {
+                targ = new Targument();
+            }
+            
+            targ.setRefAttribute(ref);
+        }
+        
+        // TODO process description, index of Arg annotation
+        return targ;
+    }
+
     private String convertFromMethodName(String name) {
         if (name.length() > 3) {
             name = name.substring(3);

Modified: incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/Account.java
URL: http://svn.apache.org/viewvc/incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/Account.java?rev=943269&r1=943268&r2=943269&view=diff
==============================================================================
--- incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/Account.java (original)
+++ incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/Account.java Tue May 11 20:24:37 2010
@@ -16,16 +16,14 @@
  */
 package org.apache.aries.blueprint.sample;
 
-import org.apache.aries.blueprint.annotation.Inject;
+import org.apache.aries.blueprint.annotation.Arg;
 import org.apache.aries.blueprint.annotation.Bean;
 
-@Bean(id="accountOne")
+@Bean(id="accountOne", args=@Arg(value="1"))
 public class Account {
     
     private long accountNumber;
     
-    @Inject(value="1")
-    // @Inject(values={"1"})
     public Account(long number) {
         this.accountNumber = number;
     }

Modified: incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/AccountFactory.java
URL: http://svn.apache.org/viewvc/incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/AccountFactory.java?rev=943269&r1=943268&r2=943269&view=diff
==============================================================================
--- incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/AccountFactory.java (original)
+++ incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/AccountFactory.java Tue May 11 20:24:37 2010
@@ -17,21 +17,18 @@
 package org.apache.aries.blueprint.sample;
 
 import org.apache.aries.blueprint.annotation.Bean;
-import org.apache.aries.blueprint.annotation.Inject;
-import org.apache.aries.blueprint.annotation.FactoryMethod;
+import org.apache.aries.blueprint.annotation.Arg;
 
-//@Bean(id="accountFactory")
+@Bean(id="accountFactory", args=@Arg(value="account factory"))
 public class AccountFactory {
     private String factoryName;
 
-    //@Inject(value="account factory")
     public AccountFactory(String factoryName) {
         this.factoryName = factoryName;
     }
 
-    //@FactoryMethod(values="3")
-    public NewAccount createAccount(long number) {
-        return new NewAccount(number);
+    public AccountNew createAccount(long number) {
+        return new AccountNew(number);
     }
     
     public String getFactoryName() {

Modified: incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/StaticAccountFactory.java
URL: http://svn.apache.org/viewvc/incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/StaticAccountFactory.java?rev=943269&r1=943268&r2=943269&view=diff
==============================================================================
--- incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/StaticAccountFactory.java (original)
+++ incubator/aries/trunk/blueprint/blueprint-sample-annotation/src/main/java/org/apache/aries/blueprint/sample/StaticAccountFactory.java Tue May 11 20:24:37 2010
@@ -16,13 +16,14 @@
  */
 package org.apache.aries.blueprint.sample;
 
+import org.apache.aries.blueprint.annotation.Arg;
 import org.apache.aries.blueprint.annotation.Bean;
-import org.apache.aries.blueprint.annotation.FactoryMethod;
 
-@Bean(id="accountTwo")
+@Bean(id="accountTwo", 
+      factoryMethod="createAccount", 
+      args = @Arg(value="2"))
 public class StaticAccountFactory {
     
-    @FactoryMethod(values={"2"})
     public static Account createAccount(long number) {
         return new Account(number);
      }