servicemix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ge...@apache.org
Subject svn commit: r1042769 - in /servicemix/components/engines/servicemix-scripting/trunk: pom.xml src/main/java/org/apache/servicemix/scripting/ScriptingEndpoint.java
Date Mon, 06 Dec 2010 19:40:43 GMT
Author: gertv
Date: Mon Dec  6 19:40:42 2010
New Revision: 1042769

URL: http://svn.apache.org/viewvc?rev=1042769&view=rev
Log:
Add better javadocs to improve generated wiki/xsd documentation

Modified:
    servicemix/components/engines/servicemix-scripting/trunk/pom.xml
    servicemix/components/engines/servicemix-scripting/trunk/src/main/java/org/apache/servicemix/scripting/ScriptingEndpoint.java

Modified: servicemix/components/engines/servicemix-scripting/trunk/pom.xml
URL: http://svn.apache.org/viewvc/servicemix/components/engines/servicemix-scripting/trunk/pom.xml?rev=1042769&r1=1042768&r2=1042769&view=diff
==============================================================================
--- servicemix/components/engines/servicemix-scripting/trunk/pom.xml (original)
+++ servicemix/components/engines/servicemix-scripting/trunk/pom.xml Mon Dec  6 19:40:42 2010
@@ -157,6 +157,13 @@
                 </exclusion>
             </exclusions>
         </dependency>
+
+        <!-- documentation -->
+        <dependency>
+            <groupId>org.apache.servicemix</groupId>
+            <artifactId>servicemix-common</artifactId>
+            <classifier>sources</classifier>
+        </dependency>      
     </dependencies>
 
     <build>

Modified: servicemix/components/engines/servicemix-scripting/trunk/src/main/java/org/apache/servicemix/scripting/ScriptingEndpoint.java
URL: http://svn.apache.org/viewvc/servicemix/components/engines/servicemix-scripting/trunk/src/main/java/org/apache/servicemix/scripting/ScriptingEndpoint.java?rev=1042769&r1=1042768&r2=1042769&view=diff
==============================================================================
--- servicemix/components/engines/servicemix-scripting/trunk/src/main/java/org/apache/servicemix/scripting/ScriptingEndpoint.java
(original)
+++ servicemix/components/engines/servicemix-scripting/trunk/src/main/java/org/apache/servicemix/scripting/ScriptingEndpoint.java
Mon Dec  6 19:40:42 2010
@@ -136,8 +136,6 @@ public class ScriptingEndpoint extends P
     }
 
     /**
-     * *
-     * 
      * @return Returns the language.
      */
     public String getLanguage() {
@@ -145,8 +143,6 @@ public class ScriptingEndpoint extends P
     }
 
     /**
-     * *
-     * 
      * @return Returns the logResourceBundle.
      */
     public String getLogResourceBundle() {
@@ -373,6 +369,8 @@ public class ScriptingEndpoint extends P
     }
 
     /**
+     * A Map with additional variables that are made available during script execution.
+     *
      * @param bindings the bindings to set
      */
     public void setBindings(Map<String, Object> bindings) {
@@ -380,6 +378,9 @@ public class ScriptingEndpoint extends P
     }
 
     /**
+     * Set this flag to true to <code>true</code> to avoid sending back a response
message.
+     * Defaults to <code>false</code>
+     * 
      * @param disableOutput the disableOutput to set
      */
     public void setDisableOutput(boolean disableOutput) {
@@ -387,6 +388,9 @@ public class ScriptingEndpoint extends P
     }
 
     /**
+     * The scripting language to be used.  Defaults to <code>autodetect</code>
to determine the language
+     * by the script file extension.
+     *
      * @param language The language to set.
      */
     public void setLanguage(String language) {
@@ -394,6 +398,8 @@ public class ScriptingEndpoint extends P
     }
 
     /**
+     * The resource bundle to use when logging internationalized messages.
+     *
      * @param logResourceBundle The logResourceBundle to set.
      */
     public void setLogResourceBundle(String logResourceBundle) {
@@ -401,6 +407,8 @@ public class ScriptingEndpoint extends P
     }
 
     /**
+     * Custom marshaler implementation to handle startup/shutdown, loading the script code
and registering additional user beans.
+     *
      * @param marshaler the marshaler to set
      */
     public void setMarshaler(ScriptingMarshalerSupport marshaler) {
@@ -408,6 +416,8 @@ public class ScriptingEndpoint extends P
     }
 
     /**
+     * Spring Resource referring to the script location.
+     *
      * @param script the script to set
      */
     public void setScript(Resource script) {
@@ -415,7 +425,7 @@ public class ScriptingEndpoint extends P
     }
 
     /**
-     * Sets the logger to use if the script decides to log
+     * Sets the logger to use if the script decides to log.
      * 
      * @param scriptLogger
      */
@@ -576,91 +586,112 @@ public class ScriptingEndpoint extends P
         }
     }
 
-    /** * @return Returns the copyProperties.
+    /**
+     * @return Returns the copyProperties.
      */
     public boolean isCopyProperties() {
         return this.copyProperties;
     }
 
     /**
+     * Copy the properties into the 'out' message.  Defaults to <code>true</code>.
+     *
      * @param copyProperties The copyProperties to set.
      */
     public void setCopyProperties(boolean copyProperties) {
         this.copyProperties = copyProperties;
     }
 
-    /** * @return Returns the copyAttachments.
+    /** 
+     * @return Returns the copyAttachments.
      */
     public boolean isCopyAttachments() {
         return this.copyAttachments;
     }
 
     /**
+     * Copy the attachments into the 'out' message.  Defaults to <code>true</code>.
+     *
      * @param copyAttachments The copyAttachments to set.
      */
     public void setCopyAttachments(boolean copyAttachments) {
         this.copyAttachments = copyAttachments;
     }
 
-    /** * @return Returns the targetInterface.
+    /**
+     * @return Returns the targetInterface.
      */
     public QName getTargetInterface() {
         return this.targetInterface;
     }
 
     /**
+     * Target interface for the output exchange that is created by the script.
+     *
      * @param targetInterface The targetInterface to set.
      */
     public void setTargetInterface(QName targetInterface) {
         this.targetInterface = targetInterface;
     }
 
-    /** * @return Returns the targetOperation.
+    /**
+     * @return Returns the targetOperation.
      */
     public QName getTargetOperation() {
         return this.targetOperation;
     }
 
     /**
+     * Target operation for the output exchange that is created by the script.
+     *
      * @param targetOperation The targetOperation to set.
      */
     public void setTargetOperation(QName targetOperation) {
         this.targetOperation = targetOperation;
     }
 
-    /** * @return Returns the targetService.
+    /**
+     * @return Returns the targetService.
      */
     public QName getTargetService() {
         return this.targetService;
     }
 
     /**
+     * Target service for the output exchange that is created by the script.
+     *
      * @param targetService The targetService to set.
      */
     public void setTargetService(QName targetService) {
         this.targetService = targetService;
     }
 
-    /** * @return Returns the targetEndpoint.
+    /**
+     * @return Returns the targetEndpoint.
      */
     public String getTargetEndpoint() {
         return this.targetEndpoint;
     }
 
     /**
+     * Target endpoint for the output exchange that is created by the script.
+     *
      * @param targetEndpoint The targetEndpoint to set.
      */
     public void setTargetEndpoint(String targetEndpoint) {
         this.targetEndpoint = targetEndpoint;
     }
 
-    /** * @return Returns the targetUri.
+    /**
+     * @return Returns the targetUri.
      */
     public String getTargetUri() {
         return this.targetUri;
     }
 
     /**
+     * URI for configuring target service/endpoint/interface for the exchange that is created
by the script. 
+     *
      * @param targetUri The targetUri to set.
      */
     public void setTargetUri(String targetUri) {



Mime
View raw message