forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bd...@apache.org
Subject svn commit: r1098469 - in /forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api: AbstractPlugin.java BaseInputPlugin.java BaseOutputPlugin.java
Date Mon, 02 May 2011 04:14:32 GMT
Author: bdube
Date: Mon May  2 04:14:31 2011
New Revision: 1098469

URL: http://svn.apache.org/viewvc?rev=1098469&view=rev
Log:
Add initial javadoc comments

Modified:
    forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/AbstractPlugin.java
    forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/BaseInputPlugin.java
    forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/BaseOutputPlugin.java

Modified: forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/AbstractPlugin.java
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/AbstractPlugin.java?rev=1098469&r1=1098468&r2=1098469&view=diff
==============================================================================
--- forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/AbstractPlugin.java
(original)
+++ forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/AbstractPlugin.java
Mon May  2 04:14:31 2011
@@ -25,6 +25,17 @@ import org.apache.forrest.plugin.api.For
 import org.apache.forrest.plugin.api.ForrestResult;
 import org.apache.forrest.plugin.api.ForrestSource;
 
+/**
+ * An abstract base class for plugins.
+ * <p>
+ * This class stores the {@link BundleContext} as a convenience to
+ * subclasses.
+ *
+ * @see #getBundleContext()
+ * @see ForrestPlugin
+ * @see BaseInputPlugin
+ * @see BaseOutputPlugin
+ */
 public abstract class AbstractPlugin implements ForrestPlugin {
 
   private BundleContext mContext;

Modified: forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/BaseInputPlugin.java
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/BaseInputPlugin.java?rev=1098469&r1=1098468&r2=1098469&view=diff
==============================================================================
--- forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/BaseInputPlugin.java
(original)
+++ forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/BaseInputPlugin.java
Mon May  2 04:14:31 2011
@@ -24,19 +24,47 @@ import org.apache.forrest.log.LogPlugin.
 import org.apache.forrest.plugin.api.ForrestResult;
 import org.apache.forrest.plugin.api.ForrestSource;
 
+/**
+ * Base implementation for input plugins. Input plugins override
+ * {@link #getSource(URI)}.
+ */
 public class BaseInputPlugin extends AbstractPlugin {
 
+  /**
+   * Constructs a <code>BaseInputPlugin</code>
+   * with the given {@link BundleContext}.
+   *
+   * @param context this bundle's context within the framework
+   */
   public BaseInputPlugin(final BundleContext context) {
     super(context);
   }
 
+  /**
+   * Returns a <code>ForrestSource</code> object to access
+   * the given <code>URI</code> and represent the internal format.
+   * <p>
+   * Input plugins must override this method.
+   * <p>
+   * The base implementation returns null.
+   *
+   * @param uri the source <code>URI</code>
+   * @return the <code>ForrestSource</code> representing the source object
+   */
   public ForrestSource getSource(URI uri) {
     LOG.debug("BaseInputPlugin.getSource() must be implemented by a plugin, ignoring");
 
     return null;
   }
 
-  public ForrestResult transform(ForrestSource source) {
+  /**
+   * Input plugins do not implement this method. The base
+   * implementation returns null.
+   *
+   * @param source the <code>ForrestSource</code> representing the source object
+   * @return null
+   */
+  public final ForrestResult transform(ForrestSource source) {
     LOG.debug("transform() called on an input plugin, ignoring");
 
     return null;

Modified: forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/BaseOutputPlugin.java
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/BaseOutputPlugin.java?rev=1098469&r1=1098468&r2=1098469&view=diff
==============================================================================
--- forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/BaseOutputPlugin.java
(original)
+++ forrest/trunk/whiteboard/forrest-osgi/org.apache.forrest.plugin.api/src/java/org/apache/forrest/plugin/api/BaseOutputPlugin.java
Mon May  2 04:14:31 2011
@@ -24,18 +24,46 @@ import org.apache.forrest.log.LogPlugin.
 import org.apache.forrest.plugin.api.ForrestResult;
 import org.apache.forrest.plugin.api.ForrestSource;
 
+/**
+ * Base implementation for output plugins. Output plugins override
+ * {@link #transform(ForrestSource)}.
+ */
 public class BaseOutputPlugin extends AbstractPlugin {
 
+  /**
+   * Constructs a <code>BaseInputPlugin</code>
+   * with the given {@link BundleContext}.
+   *
+   * @param context this bundle's context within the framework
+   */
   public BaseOutputPlugin(final BundleContext context) {
     super(context);
   }
 
-  public ForrestSource getSource(URI uri) {
+  /**
+   * Output plugins do not implement this method. The base
+   * implementation returns null.
+   *
+   * @param uri the source <code>URI</code>
+   * @return null
+   */
+  public final ForrestSource getSource(URI uri) {
     LOG.debug("getSource() called on an output plugin, ignoring");
 
     return null;
   }
 
+  /**
+   * Returns a <code>ForrestResult</code> object to access
+   * the result of the transformation.
+   * <p>
+   * Output plugins must override this method.
+   * <p>
+   * The base implementation returns null.
+   *
+   * @param source the <code>ForrestSource</code> internal format
+   * @return the <code>ForrestResult</code> transformation result
+   */
   public ForrestResult transform(ForrestSource source) {
     LOG.debug("BaseOutputPlugin.transform() must be implemented by a plugin, ignoring");
 



Mime
View raw message