[jboss-cvs] JBossAS SVN: r90163 - in projects/kernel/trunk: dependency/src/main/java/org/jboss/dependency/spi/dispatch and 10 other directories.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Fri Jun 12 12:56:23 EDT 2009
Author: kabir.khan at jboss.com
Date: 2009-06-12 12:56:23 -0400 (Fri, 12 Jun 2009)
New Revision: 90163
Added:
projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/graph/package.html
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/model/package.html
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/factory/package.html
projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/api/dependency/package.html
Modified:
projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/CallbackItem.java
projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/Controller.java
projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ControllerContext.java
projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ControllerContextActions.java
projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ControllerMode.java
projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/DependencyInfo.java
projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/DependencyItem.java
projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/LifecycleCallbackItem.java
projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ScopeInfo.java
projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/dispatch/package.html
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/MCAnnotations.java
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/package.html
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/BeanMetaData.java
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/FeatureMetaData.java
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/package.html
projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/package.html
projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/spi/annotations/package.html
projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/spi/bootstrap/package.html
projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/spi/dependency/package.html
Log:
[JBKERNEL-14] Javadoc fixes
Modified: projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/CallbackItem.java
===================================================================
--- projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/CallbackItem.java 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/CallbackItem.java 2009-06-12 16:56:23 UTC (rev 90163)
@@ -25,10 +25,9 @@
package org.jboss.dependency.spi;
/**
- * This represents a callback. These are held within a {@link ControllerContext}'s
- * {@link DependencyInfo}. The {@link ControllerContext} can have several callbacks associated
- * with it. Callbacks can either be invoked when installing the owning {@link ControllerContext} or
- * when uninstalling the owning {@link ControllerContext}. The {@link ControllerContext}s
+ * This represents a callback. The <code>ControllerContext</code> can have several callbacks associated
+ * with it. Callbacks can either be invoked when installing the owning <code>ControllerContext</code> or
+ * when uninstalling the owning <code>ControllerContext</code>. The {@link ControllerContext}'s
* {@link DependencyInfo} maintains a collection of install callbacks and a collection of
* uninstall callbacks.
* <p>
Modified: projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/Controller.java
===================================================================
--- projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/Controller.java 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/Controller.java 2009-06-12 16:56:23 UTC (rev 90163)
@@ -23,6 +23,7 @@
import java.util.Set;
+import org.jboss.dependency.spi.graph.GraphController;
import org.jboss.util.JBossInterface;
/**
@@ -30,7 +31,9 @@
* Microcontainer. It keeps track of {@link ControllerContext}s
* to make sure the configuration and lifecycle are
* done in the correct order including dependencies and
- * classloading considerations. Several controllers can exist in a hiearchy.
+ * classloading considerations. Several controllers can exist in a hiearchy,
+ * see {@link GraphController} for how to search for contexts in a hierarchy of
+ * <code>Controller</code>s.
* <p>
* The {@link ControllerContext}s each represent a bean that is to
* be installed in the Microcontainer.
Modified: projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ControllerContext.java
===================================================================
--- projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ControllerContext.java 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ControllerContext.java 2009-06-12 16:56:23 UTC (rev 90163)
@@ -27,9 +27,9 @@
/**
* A controller context represents a bean installed in the Microcontainer's
- * {@link Controller}. The {@link Controller} does work on the ControllerContext to move it through
+ * {@link Controller}. The <code>Controller</code> does work on the ControllerContext to move it through
* its lifecycle. The lifecycle is made up of a series of {@link ControllerState}s. Entry to each
- * {@link ControllerState} can be associated to trigger an action configured in the {@link ControllerContextActions}
+ * <code>ControllerState</code> can be associated to trigger an action configured in the {@link ControllerContextActions}
*
*
* @author <a href="adrian at jboss.com">Adrian Brock</a>
@@ -39,7 +39,7 @@
{
/**
* Get the name of the context. The name uniquely identifies the context in the {@link Controller}
- * (or hierarchy of {@link Controller}s).
+ * (or hierarchy of <code>Controller</code>s).
*
* @return the name
*/
@@ -118,7 +118,7 @@
/**
* Set the current state of this controller context. Once under control of the {@link Controller},
- * only the {@link Controller} should call this method
+ * only the <code>Controller</code> should call this method
*
* @param state the state
*/
@@ -151,7 +151,7 @@
/**
* Set the mode for this controller context. Once under control of the {@link Controller},
- * only the {@link Controller} should call this method.
+ * only the <code>Controller</code> should call this method.
*
* @param mode the mode
*/
Modified: projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ControllerContextActions.java
===================================================================
--- projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ControllerContextActions.java 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ControllerContextActions.java 2009-06-12 16:56:23 UTC (rev 90163)
@@ -23,29 +23,29 @@
/**
* The default implementation of {@link ControllerContext} has a reference to
- * {@link ControllerContextActions}. When a {@link ControllerContext} is installed to
+ * {@link ControllerContextActions}. When a <code>ControllerContext</code> is installed to
* or uninstalled from a given state that can be associated with an action.
* <p>
* The default actions when running the full kernel are on installing to/uninstalling from:
* <ul>
* <li>{@link ControllerState#NOT_INSTALLED} - This is the starting state
- * for {@link ControllerContext}s to be installed. Metadata for the bean has been parsed.</li>
+ * for <code>ControllerContext</code>s to be installed. Metadata for the bean has been parsed.</li>
* <li>{@link ControllerState#PRE_INSTALL} - Determine the scoping policy
- * of the {@link ControllerContext} to see if it should go in the main controller
+ * of the <code>ControllerContext</code> to see if it should go in the main controller
* or in a child controller and resolve classloading dependencies.</li>
* <li>{@link ControllerState#DESCRIBED} - Determine the bean's extra dependencies that might be brought in from the AOP layer.</li>
* <li>{@link ControllerState#PRE_INSTALL} - Instantiate the bean instance and set it
- * in the {@link ControllerContext}'s target</li>
+ * in the <code>ControllerContext</code>'s target</li>
* <li>{@link ControllerState#CONFIGURED} - Configure the bean instance with the properties
* from the bean metadata and perform injection of other bean instances.</li>
- * <li>{@link ControllerState#CREATE} - Call any create/destroy lifecycle methods. All {@link ControllerContext}s we depend on will
+ * <li>{@link ControllerState#CREATE} - Call any create/destroy lifecycle methods. All <code>ControllerContext</code>s we depend on will
* also have reached the {@link ControllerState#CREATE}</li>
- * <li>{@link ControllerState#START} - Call any start/stop lifecycle methods. All {@link ControllerContext}s we depend on will
+ * <li>{@link ControllerState#START} - Call any start/stop lifecycle methods. All <code>ControllerContext</code>s we depend on will
* also have reached the {@link ControllerState#START}</li>
* <li>{@link ControllerState#INSTALLED} - The bean is properly started. Any lifecycle
* install/uninstall methods are called on the bean and the bean gets added to the list of items the controller supplies.</li>
* </ul>
- * If something went wrong installing the {@link ControllerContext}, the {@link ControllerContext}
+ * If something went wrong installing the <code>ControllerContext</code>, the <code>ControllerContext</code>
* enters the {@link ControllerState#ERROR} state.
*
* @author <a href="adrian at jboss.com">Adrian Brock</a>
Modified: projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ControllerMode.java
===================================================================
--- projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ControllerMode.java 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ControllerMode.java 2009-06-12 16:56:23 UTC (rev 90163)
@@ -29,7 +29,7 @@
import org.jboss.xb.annotations.JBossXmlEnum;
/**
- * Enumeration used to specify the mode a {@link ControllerContext} should be installed,
+ * Enumeration used to specify the mode through which a {@link ControllerContext} should be installed,
* which has impact on what the {@link Controller} does when told to install a {@link ControllerContext}.
* The comments on the enum constants relates to running the Microcontainer in its
* default configuration.<p>
@@ -51,7 +51,7 @@
/**
* The {@link Controller} will install the {@link ControllerContext} to the {@link ControllerState#DESCRIBED}
- * state and keep it there until another {@link ControllerContext} actually wants to use it for injection.
+ * state and keep it there until another <code>ControllerContext</code> actually wants to use it for injection.
*/
@XmlEnumValue("On Demand") ON_DEMAND("On Demand", ControllerState.DESCRIBED),
MANUAL("Manual"),
@@ -61,7 +61,7 @@
DISABLED("Disabled"),
/**
* The {@link Controller} will install the {@link ControllerContext} in another thread, allowing parallel deployments.
- * The {@link ControllerContext} will be installed all the way to {@link ControllerState#INSTALLED}
+ * The <code>ControllerContext</code> will be installed all the way to {@link ControllerState#INSTALLED}
*/
ASYNCHRONOUS("Asynchronous", ControllerState.INSTALLED);
Modified: projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/DependencyInfo.java
===================================================================
--- projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/DependencyInfo.java 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/DependencyInfo.java 2009-06-12 16:56:23 UTC (rev 90163)
@@ -67,14 +67,14 @@
void removeIDependOn(DependencyItem dependency);
/**
- * Add a dependency reference
+ * Add a dependency reference on the owning {@link ControllerContext}
*
* @param dependency the dependency to add
*/
void addDependsOnMe(DependencyItem dependency);
/**
- * Remove a dependency reference
+ * Remove a dependency reference on the owning {@link ControllerContext}
*
* @param dependency the dependency to remove
*/
Modified: projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/DependencyItem.java
===================================================================
--- projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/DependencyItem.java 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/DependencyItem.java 2009-06-12 16:56:23 UTC (rev 90163)
@@ -23,12 +23,12 @@
/**
* Information about a single dependency on a {@link ControllerContext}. These are
- * held within a {@link ControllerContext}'s {@link DependencyInfo}.
+ * held within a <code>ControllerContext</code>'s {@link DependencyInfo}.
* <p>
- * When the owning {@link ControllerContext} enters the state in
- * {@link #getWhenRequired()}, if the {@link ControllerContext} we have a dependency
+ * When the owning <code>ControllerContext</code> enters the state in
+ * {@link #getWhenRequired()}, if the <code>ControllerContext</code> we have a dependency
* on has not reached the state in {@link #getDependentState()} the owning
- * {@link ControllerContext} cannot proceed to the state in {@link #getWhenRequired()}.
+ * <code>ControllerContext</code> cannot proceed to the state in <code>getWhenRequired()</code>.
*
* @author <a href="adrian at jboss.com">Adrian Brock</a>
* @version $Revision$
Modified: projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/LifecycleCallbackItem.java
===================================================================
--- projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/LifecycleCallbackItem.java 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/LifecycleCallbackItem.java 2009-06-12 16:56:23 UTC (rev 90163)
@@ -25,29 +25,38 @@
* This represents a lifecycle callback applied via aop the
* <code>
* <lifecycle-xxx>
- * </code> bindings.
+ * </code> bindings. For example:
+ * <pre>
+ * <lifecycle-configure xmlns="urn:jboss:aop-beans:1.0"
+ * name="ConfigureCallback"
+ * class="org.jboss.example.ConfigureCallback"
+ * classes="@org.jboss.example.Marker"
+ * manager-bean="AspectManager"
+ * manager-property="aspectManager">
+ * </lifecycle-configure>
+ * </pre>
*
* This represents a dependency on a {@link ControllerContext}. These are
- * held within a {@link ControllerContext}'s {@link DependencyInfo}.
+ * held within a ControllerContext's {@link DependencyInfo}.
* <p>
- * When the owning {@link ControllerContext} enters the state in
- * {@link #getWhenRequired()}, if the {@link ControllerContext} of the lifecycle callback
+ * When the owning ControllerContext enters the state in
+ * {@link #getWhenRequired()}, if the <code>ControllerContext</code> of the lifecycle callback
* we have a dependency on has not reached the state in {@link #getDependentState()} the owning
- * {@link ControllerContext} cannot proceed to the state in {@link #getWhenRequired()}.
+ * <code>ControllerContext</code> cannot proceed to the state in <code>getWhenRequired()</code>.
* <p>
- * When the owning {@link ControllerContext} enters the {@link #getWhenRequired()}
+ * When the owning <code>ControllerContext</code> enters the <code>getWhenRequired()</code>
* state on install the {@link #install(ControllerContext)} method is called by the controller.
* This will delegate to the
- * <code>
+ * <pre>
* public void install(ControllerContext context)
- * </code> method of the lifecycle callback bean implementation.
+ * </pre> method of the lifecycle callback bean implementation.
* <p>
- * On uninstalling the owning {@link ControllerContext} from the {@link #getWhenRequired()}
+ * On uninstalling the owning <code>ControllerContext</code> from the <code>#getWhenRequired()</code>
* state, the {@link #uninstall(ControllerContext)} method is called by the controller.
* This will delegate to the
- * <code>
+ * <pre>
* public void uninstall(ControllerContext context)
- * </code> method of the lifecycle callback bean implementation.
+ * </pre> method of the lifecycle callback bean implementation.
*
*
* @author <a href="kabir.khan at jboss.com">Kabir Khan</a>
Modified: projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ScopeInfo.java
===================================================================
--- projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ScopeInfo.java 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/ScopeInfo.java 2009-06-12 16:56:23 UTC (rev 90163)
@@ -32,7 +32,7 @@
/**
* ScopeInfo belongs to a {@link ControllerContext}, and is the entry point into the
- * {@link ControllerContext}'s data in the {@link MetaDataRepository}. Each {@link ControllerContext}
+ * <code>ControllerContext</code>'s data in the {@link MetaDataRepository}. Each <code>ControllerContext</code>
* has data stored under a unique {@link ScopeKey}.
*
* @author <a href="adrian at jboss.com">Adrian Brock</a>
@@ -48,7 +48,7 @@
MetaData getMetaData();
/**
- * Associates the passed in metadata repository with the controller context.
+ * Associates the passed in metadata repository with the {@link ControllerContext}.
* The {@link ScopeKey} is created and the metadata repository location for the
* controller context is created.
*
@@ -58,7 +58,7 @@
void addMetaData(MutableMetaDataRepository repository, ControllerContext context);
/**
- * Disassociates the passed in metadata repository with the controller context.
+ * Disassociates the passed in metadata repository with the {@link ControllerContext}.
* The location of the {@link ScopeKey} for the passed in controller context
* is removed from the metadata repository.
*
@@ -133,18 +133,18 @@
/**
* Get the install scope. If a scoped {@link Controller} (i.e. a child of the main {@link Controller})
- * was used, by annotating the {@link ControllerContext} with annotations annotated with {@link ScopeFactoryLookup}
- * this is the location of the scoped {@link Controller} in the underlying metadata repository.
+ * was used, by annotating the ControllerContext with annotations annotated with {@link ScopeFactoryLookup}
+ * this is the location of the scoped Controller in the underlying metadata repository.
*
* @return the scope
*/
ScopeKey getInstallScope();
/**
- * Get the install scope. If a scoped {@link Controller} (i.e. a child of the main {@link Controller})
+ * Get the install scope. If a scoped {@link Controller} (i.e. a child of the main Controller
* was used, by annotating the {@link ControllerContext} with annotations annotated with {@link ScopeFactoryLookup}
- * this is the location of the scoped {@link Controller} in the underlying metadata repository. This method should
- * only be called by the {@link Controller}.
+ * this is the location of the scoped Controller in the underlying metadata repository. This method should
+ * only be called by the Controller.
*
*
* @param key the scope key
Modified: projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/dispatch/package.html
===================================================================
--- projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/dispatch/package.html 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/dispatch/package.html 2009-06-12 16:56:23 UTC (rev 90163)
@@ -14,7 +14,8 @@
<body bgcolor="white">
<p>Interfaces that may be inplemented by a <a href="../ControllerContext.html">ControllerContext</a> implementation, which
- allows you to make calls on the <a href="../ControllerContext.html">ControllerContext</a>s underlying bean. The
+ allows you to make calls on the <code>ControllerContext</code>s underlying bean. The default implementation
+ of <code>KernelControllerContext</code> shipped with the JBoss Microcontaner supports this functionality.
<h2>Package Specification</h2>
<ul>
Added: projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/graph/package.html
===================================================================
--- projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/graph/package.html (rev 0)
+++ projects/kernel/trunk/dependency/src/main/java/org/jboss/dependency/spi/graph/package.html 2009-06-12 16:56:23 UTC (rev 90163)
@@ -0,0 +1,34 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+ <head>
+ <!-- $Id: package.html 89526 2009-05-29 11:14:38Z kabir.khan at jboss.com $ -->
+ <!--
+
+ JBoss: The OpenSource J2EE WebOS
+
+ Distributable under LGPL license.
+ See terms of license at gnu.org.
+
+ -->
+ </head>
+
+ <body bgcolor="white">
+ <p>Interfaces used to specify how to find a context when there is a hierarchy of
+ <code>Controller</code>s. <code>Controller</code> implementations may implement
+ the <code>GraphControllerInterface</code>, and this is done for the default
+ implementations shipped with the JBoss Microcontainer interface.
+
+ <h2>Package Specification</h2>
+ <ul>
+ <li><a href="javascript: alert('not available')">Not Available</a>
+ </ul>
+
+ <h2>Related Documentation</h2>
+ <ul>
+ <li><a href="javascript: alert('not available')">Not Available</a>
+ </ul>
+
+ <!-- Put @see and @since tags down here. -->
+
+ </body>
+</html>
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/MCAnnotations.java
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/MCAnnotations.java 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/MCAnnotations.java 2009-06-12 16:56:23 UTC (rev 90163)
@@ -28,8 +28,8 @@
import java.lang.annotation.Target;
/**
- * Possible IoC annotations. Can be used to narrow the number of annotations to
- * look for.
+ * Possible IoC annotations. Can be used to annotate the bean classes to narrow the number of annotations to
+ * look for as an optimization.
*
* @author <a href="mailto:ales.justin at jboss.org">Ales Justin</a>
*/
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/package.html
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/package.html 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/annotations/package.html 2009-06-12 16:56:23 UTC (rev 90163)
@@ -16,7 +16,7 @@
Annotations used to deploy beans. An example of a bean created using annotations is created here.
<pre>
@Bean(name="SomeBean")
-@Bean(name="ABean")
+@Aliases(name="ABean")
public class MyBean
{
long age;
@@ -37,9 +37,9 @@
</pre>
If this class is compiled, we can use
- <a href="../../../../kernel/spi/annotations/AnnotationToBeanMetaDataFactory.html">AnnotationToBeanMetaDataFactory</a> to obtain the
+ <a href="../../../../kernel/spi/annotations/AnnotationToBeanMetaDataFactory.html#createBeanMetaData(Class)">AnnotationToBeanMetaDataFactory.createBeanMetaData(Class)</a> to obtain the
<a href="../../spi/BeanMetaData.html">BeanMetaData</a>, which can then be deployed into the controller using the
- <a href="../../../../kernel/spi/dependency/KernelController.html">KernelController</a>.<p>
+ <a href="../../../../kernel/spi/dependency/KernelController.html#install(BeanMetaData)">KernelController.install(BeanMetaData)</a> method.<p>
Once deployed, we will have a bean called <code>MyBean</code>, with an alias <code>ABean</code>. The bean will
Added: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/model/package.html
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/model/package.html (rev 0)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/api/model/package.html 2009-06-12 16:56:23 UTC (rev 90163)
@@ -0,0 +1,31 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+ <head>
+ <!-- $Id: package.html 26060 2004-11-22 15:45:18Z ejort $ -->
+ <!--
+
+ JBoss: The OpenSource J2EE WebOS
+
+ Distributable under LGPL license.
+ See terms of license at gnu.org.
+
+ -->
+ </head>
+
+ <body bgcolor="white">
+ <p>Enums and utility classes used for autowiring, specifying injection options and contextual injection.
+
+ <h2>Package Specification</h2>
+ <ul>
+ <li><a href="javascript: alert('not available')">Not Available</a>
+ </ul>
+
+ <h2>Related Documentation</h2>
+ <ul>
+ <li><a href="javascript: alert('not available')">Not Available</a>
+ </ul>
+
+ <!-- Put @see and @since tags down here. -->
+
+ </body>
+</html>
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/BeanMetaData.java
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/BeanMetaData.java 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/BeanMetaData.java 2009-06-12 16:56:23 UTC (rev 90163)
@@ -157,6 +157,7 @@
* @return the bean annotations
*/
Set<AnnotationMetaData> getAnnotations();
+
/**
* Set the annotations. They will eventually end up in the meta data repository for the
* resulting {@link ControllerContext}.
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/FeatureMetaData.java
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/FeatureMetaData.java 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/FeatureMetaData.java 2009-06-12 16:56:23 UTC (rev 90163)
@@ -34,7 +34,7 @@
public interface FeatureMetaData extends JBossInterface, MetaDataVisitorNode
{
/**
- * Get the descrition.
+ * Get the description.
*
* @return the description.
*/
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-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/builder/BeanMetaDataBuilder.java 2009-06-12 16:56:23 UTC (rev 90163)
@@ -415,7 +415,7 @@
public abstract BeanMetaDataBuilder setFactory(ValueMetaData factory);
/**
- * Set the non-static factory class to use constructing the bean
+ * Set the static factory class to use constructing the bean
*
* @see BeanMetaData#getConstructor()
* @see ConstructorMetaData#getFactoryClass()
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/builder/package.html
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/builder/package.html 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/builder/package.html 2009-06-12 16:56:23 UTC (rev 90163)
@@ -13,7 +13,26 @@
</head>
<body bgcolor="white">
- <p>Classes used to construct <a href="../BeanMetaData.html">BeanMetaData</a> programatically.
+ <p>Classes used to construct <a href="../BeanMetaData.html">BeanMetaData</a> programatically as shown below:
+ <pre>
+ Kernel kernel = ...//Get from bootstrap
+ BeanMetaDataBuilder builder = BeanMetaDataBuilderFactory.createBuilder("SomeBean", SimpleBean.class.getName());
+ builder.addAlias("BeanA");
+ kernel.getController().install(builder.getBeanMetaData());
+
+ builder = BeanMetaDataBuilderFactory.createBuilder("OtherBean", OtherBean.class.getName());
+ ValueMetaData vmd = builder.createInject("BeanA");
+ builder.addPropertyMetaData("someBean", vmd);
+ kernel.getController().install(builder.getBeanMetaData());
+ </pre>
+
+ <p>This example obtains a reference to the <code>Kernel</code> from the bootstrap.
+ It then creates the metadata for a bean, giving it the name <code>SomeBean</code> and the class <code>SimpleBean</code>,
+ and adds an alias <code>BeanA</code>. The bean metadata is then installed into the kernel's controller.
+
+ <p>Next a bean called <code>OtherBean</code> with the class <code>OtherBean</code> is created. The metadata is then set
+ up to inject the bean <code>BeanA</code> (which is <code>SomeBean</code>'s alias) into the <code>someBean</code> property
+ of <code>OtherBean</code>.
<h2>Package Specification</h2>
<ul>
Added: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/factory/package.html
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/factory/package.html (rev 0)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/factory/package.html 2009-06-12 16:56:23 UTC (rev 90163)
@@ -0,0 +1,32 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+ <head>
+ <!-- $Id: package.html 26060 2004-11-22 15:45:18Z ejort $ -->
+ <!--
+
+ JBoss: The OpenSource J2EE WebOS
+
+ Distributable under LGPL license.
+ See terms of license at gnu.org.
+
+ -->
+ </head>
+
+ <body bgcolor="white">
+ <p>Classes used to parse and define bean factories. A bean factory is installed
+ much like a normal bean, but is used to create actual bean instances.
+
+ <h2>Package Specification</h2>
+ <ul>
+ <li><a href="javascript: alert('not available')">Not Available</a>
+ </ul>
+
+ <h2>Related Documentation</h2>
+ <ul>
+ <li><a href="javascript: alert('not available')">Not Available</a>
+ </ul>
+
+ <!-- Put @see and @since tags down here. -->
+
+ </body>
+</html>
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/package.html
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/package.html 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/beans/metadata/spi/package.html 2009-06-12 16:56:23 UTC (rev 90163)
@@ -15,7 +15,8 @@
<body bgcolor="white">
<p>Classes used to describe beans for deployment. Whether you are deploying beans using a <code>-beans.xml</code> or
using annotations, they all end up as <code>BeanMetaData</code> which describes one bean. To construct a bean
- programatically, the <a href="builder/BeanMetaDataBuilder.html">BeanMetaDataBuilder</a> can be used.
+ programatically, the <a href="builder/BeanMetaDataBuilder.html">BeanMetaDataBuilder</a> can be used. See the user guide
+ and examples for more information on deploying beans via xml or annotations.
<h2>Package Specification</h2>
<ul>
Added: projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/api/dependency/package.html
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/api/dependency/package.html (rev 0)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/api/dependency/package.html 2009-06-12 16:56:23 UTC (rev 90163)
@@ -0,0 +1,34 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+ <head>
+ <!-- $Id: package.html 89824 2009-06-04 14:20:48Z kabir.khan at jboss.com $ -->
+ <!--
+
+ JBoss: The OpenSource J2EE WebOS
+
+ Distributable under LGPL license.
+ See terms of license at gnu.org.
+
+ -->
+ </head>
+
+ <body bgcolor="white">
+ <p>Classes used to match between a <code>demand</code> and the available <code>supplies</code> available in the Microcontainer.
+ The default matcher uses exact matches between the name supplied and the name demanded, but other implementations such as
+ regular expressions are available.
+
+
+ <h2>Package Specification</h2>
+ <ul>
+ <li><a href="javascript: alert('not available')">Not Available</a>
+ </ul>
+
+ <h2>Related Documentation</h2>
+ <ul>
+ <li><a href="javascript: alert('not available')">Not Available</a>
+ </ul>
+
+ <!-- Put @see and @since tags down here. -->
+
+ </body>
+</html>
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/spi/annotations/package.html
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/spi/annotations/package.html 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/spi/annotations/package.html 2009-06-12 16:56:23 UTC (rev 90163)
@@ -13,7 +13,7 @@
</head>
<body bgcolor="white">
- <p>Classes used to define the plugins used when bootstrapping the kernel to create the services that make up the kernel.
+ <p>Classes used to define the plugins used to parse MC annotations to create bean metadata.
<h2>Package Specification</h2>
<ul>
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/spi/bootstrap/package.html
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/spi/bootstrap/package.html 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/spi/bootstrap/package.html 2009-06-12 16:56:23 UTC (rev 90163)
@@ -13,7 +13,7 @@
</head>
<body bgcolor="white">
- <p>Classes used to define the plugins used to parse MC annotations to create bean metadata.
+ <p>Classes used to define the plugins used when bootstrapping the kernel to create the services that make up the kernel.
<h2>Package Specification</h2>
<ul>
Modified: projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/spi/dependency/package.html
===================================================================
--- projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/spi/dependency/package.html 2009-06-12 16:54:40 UTC (rev 90162)
+++ projects/kernel/trunk/kernel/src/main/java/org/jboss/kernel/spi/dependency/package.html 2009-06-12 16:56:23 UTC (rev 90163)
@@ -13,7 +13,7 @@
</head>
<body bgcolor="white">
- <p>Classes used to define dependency plugins.
+ <p>Additional functionality in the core state-maching, and axtensions to the interfaces used when running the <code>Controller</code> in Kernel mode.
<h2>Package Specification</h2>
<ul>
@@ -30,11 +30,6 @@
<li><font color="red"><b>ALPHA</b></font>
</ul>
- <h2>Todo</h2>
- <ul>
- <li>???
- </ul>
-
<!-- Put @see and @since tags down here. -->
</body>
More information about the jboss-cvs-commits
mailing list