Author: struberg
Date: Mon Aug 29 14:41:30 2011
New Revision: 1162837
URL: http://svn.apache.org/viewvc?rev=1162837&view=rev
Log:
OWB-571 improve JavaDoc and fix broken external Java6 references
Modified:
openwebbeans/trunk/pom.xml
openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/plugins/PluginLoader.java
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/FailOverService.java
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/ResourceInjectionService.java
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/adaptor/ELAdaptor.java
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/plugins/AbstractOwbPlugin.java
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/plugins/OpenWebBeansPlugin.java
openwebbeans/trunk/webbeans-spi/src/site/site.xml
Modified: openwebbeans/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/openwebbeans/trunk/pom.xml?rev=1162837&r1=1162836&r2=1162837&view=diff
==============================================================================
--- openwebbeans/trunk/pom.xml (original)
+++ openwebbeans/trunk/pom.xml Mon Aug 29 14:41:30 2011
@@ -420,8 +420,8 @@
<configuration>
<quiet>true</quiet>
<links>
- <link>http://java.sun.com/javaee/6/docs/api</link>
- <link>http://java.sun.com/j2se/1.6.0/docs/api</link>
+ <link>http://download.oracle.com/javaee/6/api/</link>
+
<link>http://download.oracle.com/javase/6/docs/api/</link>
<link>http://myfaces.apache.org/core20/myfaces-api/apidocs/</link>
</links>
</configuration>
Modified:
openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/plugins/PluginLoader.java
URL:
http://svn.apache.org/viewvc/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/plugins/PluginLoader.java?rev=1162837&r1=1162836&r2=1162837&view=diff
==============================================================================
---
openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/plugins/PluginLoader.java
(original)
+++
openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/plugins/PluginLoader.java
Mon Aug 29 14:41:30 2011
@@ -43,8 +43,6 @@ import org.apache.webbeans.spi.plugins.O
* {@link
http://java.sun.com/javase/6/docs/technotes/guides/jar/jar.html#Service%20Provider}.
* A jar containing an OWB plugin has to expose itself in the file
*
<code>META-INF/services/org.apache.webbeans.plugins.OpenWebBeansPlugin</code></p>
- *
- * TODO: what about ordering the plugins via an ordinal?
*/
public class PluginLoader
{
Modified:
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/FailOverService.java
URL:
http://svn.apache.org/viewvc/openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/FailOverService.java?rev=1162837&r1=1162836&r2=1162837&view=diff
==============================================================================
---
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/FailOverService.java
(original)
+++
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/FailOverService.java
Mon Aug 29 14:41:30 2011
@@ -37,40 +37,36 @@ public interface FailOverService
/**
* Used for tracking the origin of serialized bean instances.
*
- * @return
+ * @return an UUID which is unique for each installation. This might
change on restarts.
*/
public String getJVMId();
/**
- * The session attribute name used to store the bean instances bag
- *
- * @return
+ * @return The session attribute name used to store the bean instances bag
*/
public String getFailOverAttributeName();
/**
- * Whether or not to support failover.
- * @return
+ * @return Whether or not the system supports failover
*/
public boolean isSupportFailOver();
/**
- * Whether or not to support passivation.
- * @return
+ * @return Whether or not the system support passivation
*/
public boolean isSupportPassivation();
/**
* Enable failover support.
*
- * @param flag
+ * @param flag <code>true</code> to enable failover support
*/
public void enableFailOverSupport(boolean flag);
/**
* Enable passivation support.
*
- * @param flag
+ * @param flag <code>true</code> to enable passivation support
*/
public void enablePassivationSupport(boolean flag);
@@ -137,7 +133,7 @@ public interface FailOverService
* @param in The input object stream
* @param out The output object stream
*
- * @return NOT_HANDLED if not handled by handler.
+ * @return {@link #NOT_HANDLED} if not handled by handler.
*/
public Object handleResource(
Bean<?> bean,
Modified:
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/ResourceInjectionService.java
URL:
http://svn.apache.org/viewvc/openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/ResourceInjectionService.java?rev=1162837&r1=1162836&r2=1162837&view=diff
==============================================================================
---
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/ResourceInjectionService.java
(original)
+++
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/ResourceInjectionService.java
Mon Aug 29 14:41:30 2011
@@ -31,7 +31,6 @@ import org.apache.webbeans.spi.api.Resou
* This service is responsible for injecting
* the Java EE injectable resources. Please
* see the Section 5 of the Java EE specification.
- * @version $Rev$ $Date$
*
*/
public interface ResourceInjectionService
@@ -68,7 +67,7 @@ public interface ResourceInjectionServic
* </p>
* @param <T> resource type, @EJB, @Resource, @WebServiceRef,
@PersistenceContext or @PersistenceUnit
* @param resourceReference
- * @return
+ * @return resource for the given resource reference
*/
public <X,T extends Annotation> X
getResourceReference(ResourceReference<X,T> resourceReference);
Modified:
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/adaptor/ELAdaptor.java
URL:
http://svn.apache.org/viewvc/openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/adaptor/ELAdaptor.java?rev=1162837&r1=1162836&r2=1162837&view=diff
==============================================================================
---
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/adaptor/ELAdaptor.java
(original)
+++
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/adaptor/ELAdaptor.java
Mon Aug 29 14:41:30 2011
@@ -21,6 +21,12 @@ package org.apache.webbeans.spi.adaptor;
import javax.el.ELResolver;
import javax.el.ExpressionFactory;
+/**
+ * This SPI allows to separate ExpressionLanguage dependencies from OWB core.
+ * This is mainly needed to support different EL specification versions.
+ * We currently support EL-2.2 in openwebbeans-impl natively and also provide a
+ * pluggable implementation for EL-1.0 in our openwebbeans-el10 module.
+ */
public interface ELAdaptor
{
public ELResolver getOwbELResolver();
Modified:
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/plugins/AbstractOwbPlugin.java
URL:
http://svn.apache.org/viewvc/openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/plugins/AbstractOwbPlugin.java?rev=1162837&r1=1162836&r2=1162837&view=diff
==============================================================================
---
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/plugins/AbstractOwbPlugin.java
(original)
+++
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/plugins/AbstractOwbPlugin.java
Mon Aug 29 14:41:30 2011
@@ -36,23 +36,23 @@ public abstract class AbstractOwbPlugin
}
- /** @{inheritDoc} */
+ /** {@inheritDoc} */
public void isManagedBean(Class<?> clazz)
{
}
- /** @{inheritDoc} */
+ /** {@inheritDoc} */
public boolean supportsJavaEeComponentInjections(Class<?> targetClass)
{
return false;
}
- /** @{inheritDoc} */
+ /** {@inheritDoc} */
public void shutDown()
{
}
- /** @{inheritDoc} */
+ /** {@inheritDoc} */
public void startUp()
{
}
Modified:
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/plugins/OpenWebBeansPlugin.java
URL:
http://svn.apache.org/viewvc/openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/plugins/OpenWebBeansPlugin.java?rev=1162837&r1=1162836&r2=1162837&view=diff
==============================================================================
---
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/plugins/OpenWebBeansPlugin.java
(original)
+++
openwebbeans/trunk/webbeans-spi/src/main/java/org/apache/webbeans/spi/plugins/OpenWebBeansPlugin.java
Mon Aug 29 14:41:30 2011
@@ -20,7 +20,7 @@ package org.apache.webbeans.spi.plugins;
/**
- * <p>Interface which all OpenWebBeans plugins has to implement to
+ * <p>Interface which all OpenWebBeans plugins have to implement to
* extend the webbeans-core with additional IOC functionality.</p>
*
* <p>There are 4 different types of functions for this interface:
Modified: openwebbeans/trunk/webbeans-spi/src/site/site.xml
URL:
http://svn.apache.org/viewvc/openwebbeans/trunk/webbeans-spi/src/site/site.xml?rev=1162837&r1=1162836&r2=1162837&view=diff
==============================================================================
--- openwebbeans/trunk/webbeans-spi/src/site/site.xml (original)
+++ openwebbeans/trunk/webbeans-spi/src/site/site.xml Mon Aug 29 14:41:30 2011
@@ -41,6 +41,11 @@
<item name="OWB-SPI"
href="http://openwebbeans.apache.org/${project.version}/openwebbeans-spi"/>
</breadcrumbs>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html" />
+ <item name="Configuration" href="configuration.html" />
+ </menu>
+
<menu ref="reports"/>
</body>
</project>
