incubator-sling-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fmesc...@apache.org
Subject svn commit: r581698 - /incubator/sling/trunk/scripting-core/src/main/java/org/apache/sling/scripting/ScriptHandler.java
Date Wed, 03 Oct 2007 19:21:55 GMT
Author: fmeschbe
Date: Wed Oct  3 12:21:55 2007
New Revision: 581698

URL: http://svn.apache.org/viewvc?rev=581698&view=rev
Log:
Add some JavaDoc

Modified:
    incubator/sling/trunk/scripting-core/src/main/java/org/apache/sling/scripting/ScriptHandler.java

Modified: incubator/sling/trunk/scripting-core/src/main/java/org/apache/sling/scripting/ScriptHandler.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/scripting-core/src/main/java/org/apache/sling/scripting/ScriptHandler.java?rev=581698&r1=581697&r2=581698&view=diff
==============================================================================
--- incubator/sling/trunk/scripting-core/src/main/java/org/apache/sling/scripting/ScriptHandler.java
(original)
+++ incubator/sling/trunk/scripting-core/src/main/java/org/apache/sling/scripting/ScriptHandler.java
Wed Oct  3 12:21:55 2007
@@ -19,16 +19,24 @@
 import org.apache.sling.component.Component;
 
 
-// this is a service interface. components required to register
+/**
+ * The <code>ScriptHandler</code> service interface may be implemented by
+ * bundles implementing support for scripting languages such as JSP, ECMA
+ * or JSR-223 scripting.
+ */
 public interface ScriptHandler {
 
-    // initialize the script handler with a prepared ServletConfig
-    // --> really, or should the handler build the config from its
-    // bundle/component context ??
-
-    // return the script types supported by this handler
+    /**
+     * Returns the type of script supported by this handler. This value is
+     * compared to the script type of the ScriptedComponent.
+     * <p>
+     * For example a handler for JSP scripts might return <em>jsp</em>.
+     */
     String getType();
 
-    // return a ComponentRenderer for the script
+    /**
+     * Returns a {@link ComponentRenderer} called by the ScriptedComponent
+     * to actually executed the script on behalf of the component.
+     */
     ComponentRenderer getComponentRenderer(Component component, String scriptName);
 }



Mime
View raw message