[jboss-cvs] JBossAS SVN: r90084 - in projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata: spi and 1 other directories.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Thu Jun 11 07:45:25 EDT 2009
Author: kabir.khan at jboss.com
Date: 2009-06-11 07:45:25 -0400 (Thu, 11 Jun 2009)
New Revision: 90084
Modified:
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/ArrayValue.java
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/CollectionValue.java
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/ListValue.java
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/MapValue.java
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/ValueFactory.java
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/PropertyMetaData.java
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/builder/BeanMetaDataBuilder.java
Log:
[JBKERNEL-14] Fixes to javadoc from cross-referencig with user guide
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/ArrayValue.java
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/ArrayValue.java 2009-06-11 11:12:26 UTC (rev 90083)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/ArrayValue.java 2009-06-11 11:45:25 UTC (rev 90084)
@@ -30,7 +30,7 @@
* Creates an array that can be used as a parameter.
*
* <pre>
- * @ArrayValue(elementClass="java.lang.Float",
+ * @ArrayValue(elementClass=java.lang.Float.class,
* {@Value(string=@StringValue("1.0")),
* @Value(string=@StringValue("2.0"))})
* public void setArray(Float[] array) {}
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/CollectionValue.java
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/CollectionValue.java 2009-06-11 11:12:26 UTC (rev 90083)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/CollectionValue.java 2009-06-11 11:45:25 UTC (rev 90084)
@@ -30,8 +30,8 @@
* Creates a collection that can be used as a parameter.
*
* <pre>
- * @CollectionValue(elementClass="java.lang.String",
- * clazz="org.jboss.example.CustomCollection",
+ * @CollectionValue(elementClass=java.lang.String.class,
+ * clazz=org.jboss.example.CustomCollection.class,
* {@Value(string=@StringValue("string1")),
* @Value(string=@StringValue("string2")),
* @Value(string=@StringValue("string3")),
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/ListValue.java
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/ListValue.java 2009-06-11 11:12:26 UTC (rev 90083)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/ListValue.java 2009-06-11 11:45:25 UTC (rev 90084)
@@ -29,8 +29,8 @@
/**
* Creates a list that can be used as a parameter
* <pre>
- * @ListValue(elementClass="java.lang.String",
- * clazz="org.jboss.example.CustomList",
+ * @ListValue(elementClass=java.lang.String.class,
+ * clazz=org.jboss.example.CustomList.class,
* {@Value(string=@StringValue("string1")),
* @Value(string=@StringValue("string2")),
* @Value(string=@StringValue("string3")),
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/MapValue.java
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/MapValue.java 2009-06-11 11:12:26 UTC (rev 90083)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/MapValue.java 2009-06-11 11:45:25 UTC (rev 90084)
@@ -29,8 +29,8 @@
/**
* Creates a map that can be used as a parameter
* <pre>
- * @MapValue(keyClass="java.lang.String",
- * valueClass="java.lang.String",
+ * @MapValue(keyClass=java.lang.String.class,
+ * valueClass=java.lang.String.class,
* {@EntryValue(key=@Value(string=@StringValue("foo.bar.key")),
* value=@Value(string=@StringValue("QWERT"))),
* @EntryValue(key=@Value(string=@StringValue("xyz.key")),
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/ValueFactory.java
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/ValueFactory.java 2009-06-11 11:12:26 UTC (rev 90083)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/ValueFactory.java 2009-06-11 11:45:25 UTC (rev 90084)
@@ -46,35 +46,35 @@
public @interface ValueFactory
{
/**
- * Get the bean.
+ * Get the bean name containing the method.
*
* @return the bean
*/
String bean();
/**
- * Get the method.
+ * Get the method name.
*
* @return the method
*/
String method();
/**
- * Get single parameter.
+ * Get single parameter. Cannot be used in conjunction with {@link #parameters()}
*
* @return the single parameter
*/
String parameter() default "";
/**
- * Get parameters.
+ * Get parameters. Cannot be used in conjunction with {@link #parameter()}
*
* @return the parameters
*/
Parameter[] parameters() default {};
/**
- * Get default value.
+ * Get default value to be used if the result of the method call is null.
*
* @return the default value
*/
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/PropertyMetaData.java
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/PropertyMetaData.java 2009-06-11 11:12:26 UTC (rev 90083)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/PropertyMetaData.java 2009-06-11 11:45:25 UTC (rev 90084)
@@ -44,7 +44,11 @@
String getType();
/**
- * Get the preinstantiate flag.
+ * Get the preinstantiate flag. Significant for properties taking collection/array/map values.
+ * The default is <code>true</code>. When true, if the property getter returns an exisiting value
+ * any values in the collection/array/map defined in the deployment description are added to the
+ * exisiting property collection/array/map. If false, the collection/array/map defined in the deployment
+ * descriptor overwrites the exisiting property value.
*
* @return the preinstantiate flag
*/
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/builder/BeanMetaDataBuilder.java
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/builder/BeanMetaDataBuilder.java 2009-06-11 11:12:26 UTC (rev 90083)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/builder/BeanMetaDataBuilder.java 2009-06-11 11:45:25 UTC (rev 90084)
@@ -2051,7 +2051,10 @@
public abstract ValueMetaData createFromContextInject(FromContext fromContext, Object contextName, ControllerState dependentState, SearchInfo search);
/**
- * Create a new collection
+ * Create a new collection. At injection time, if the target property already has a
+ * collection that collection's type will be used. Otherwise, the exact type of the collection
+ * used will be determined by introspecting the target parameter/property. If the target
+ * is an interface java.util.ArrayList will be used by default.
*
* @return the collection
*/
@@ -2063,14 +2066,17 @@
/**
* Create a new collection, where we can specify the exact type of Collection we would like
*
- * @param collectionType the collection type
- * @param elementType the element type
+ * @param collectionType the collection type class name
+ * @param elementType the element type class name
* @return the collection
*/
public abstract Collection<ValueMetaData> createCollection(String collectionType, String elementType);
/**
- * Create a new list
+ * Create a new list. At injection time, if the target property already has a
+ * list that list's type will be used. Otherwise, the exact type of the list
+ * used will be determined by introspecting the target parameter/property. If the target
+ * is an interface java.util.ArrayList will be used by default.
*
* @return the list
*/
@@ -2082,14 +2088,17 @@
/**
* Create a new list, where we can specify the exact type of List we would like
*
- * @param listType the list type
- * @param elementType the element type
+ * @param listType the class name of the List implementation.
+ * @param elementType the element type class name
* @return the list
*/
public abstract List<ValueMetaData> createList(String listType, String elementType);
/**
- * Create a new set
+ * Create a new set. At injection time, if the target property already has a
+ * set that set's type will be used. Otherwise, the exact type of the set
+ * used will be determined by introspecting the target parameter/property. If the target
+ * is an interface java.util.HashSet will be used by default.
*
* @return the set
*/
@@ -2099,16 +2108,19 @@
}
/**
- * Create a new set, where we can specify the exact type of Set we would like
+ * Create a new list, where we can specify the exact type of set we would like
*
- * @param setType the set type
- * @param elementType the element type
+ * @param setType the class name of the Set implementation we would like to use
+ * @param elementType the element type class name
* @return the set
*/
public abstract Set<ValueMetaData> createSet(String setType, String elementType);
/**
- * Create a new array
+ * Create a new array. At injection time, if the target property already has a
+ * array that array's type will be used. Otherwise, the exact type of the array
+ * used will be determined by introspecting the target parameter/property. The
+ * default type is java.lang.Object[]
*
* @return the array
*/
@@ -2120,8 +2132,8 @@
/**
* Create a new array, where we can specify the exact type of array we would like
*
- * @param arrayType the array type
- * @param elementType the element type
+ * @param arrayType the array type class name
+ * @param elementType the element type class name
* @return the set
*/
public abstract List<ValueMetaData> createArray(String arrayType, String elementType);
@@ -2139,9 +2151,9 @@
/**
* Create a new map, where we can specify the exact type of Map we would like
*
- * @param mapType the map type
- * @param keyType the key type
- * @param valueType the value type
+ * @param mapType the map type class name
+ * @param keyType the key type class name
+ * @param valueType the value type class name
* @return the map
*/
public abstract Map<ValueMetaData, ValueMetaData> createMap(String mapType, String keyType, String valueType);
More information about the jboss-cvs-commits
mailing list