Author: rahul
Date: Sun Jan 11 16:49:37 2009
New Revision: 733556

URL: http://svn.apache.org/viewvc?rev=733556&view=rev
Log:
Fix Javadoc warnings in the oat.rdc.core package as reported by the m2 build. 
Also add serialVersionUIDs where needed.

Modified:
    
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/BaseModel.java
    
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/ComponentModel.java
    
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/DialogManager.java
    
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/Grammar.java
    
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/GroupModel.java
    
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/GroupTag.java
    
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/IncludeFSMFragmentTag.java
    
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/NBestResults.java
    
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/RDCTemplate.java
    
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/StrutsSubmitTag.java

Modified: 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/BaseModel.java
URL: 
http://svn.apache.org/viewvc/jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/BaseModel.java?rev=733556&r1=733555&r2=733556&view=diff
==============================================================================
--- 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/BaseModel.java
 (original)
+++ 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/BaseModel.java
 Sun Jan 11 16:49:37 2009
@@ -415,7 +415,7 @@
      * Get the grammar path(s) for the RDC
      * grammars is a read only property
      * 
-     * @param grammars - the grammar path(s)
+     * @return The grammar path(s)
      */
     public List getGrammars() {
         return grammars;
@@ -445,7 +445,7 @@
     /**
      * Set whether the user has requested echo
      * 
-     * @param isEcho - the user's choice to echo the return value
+     * @param echo - the user's choice to echo the return value
      */
     public void setEcho(Boolean echo) {
         if (echo != null) {
@@ -465,7 +465,7 @@
     /**
      * Set the map of ambiguous values
      * 
-     * @param ambiguousValues is a map containing the ambiguous values
+     * @param ambigValues A map containing the ambiguous values
      */
     public void setAmbiguousValues(Map ambigValues) {
         this.ambiguousValues = ambigValues;
@@ -611,7 +611,7 @@
      * Treatment depends on whether this component instance implements
      * the ValueInterpreter interface. 
      * 
-     * @param string candidates the serialized n-best results from the vxml 
browser
+     * @param candidates The serialized n-best results from the vxml browser
      * @see ValueInterpreter interface
      */
     public void setCandidates(String candidates) {

Modified: 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/ComponentModel.java
URL: 
http://svn.apache.org/viewvc/jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/ComponentModel.java?rev=733556&r1=733555&r2=733556&view=diff
==============================================================================
--- 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/ComponentModel.java
 (original)
+++ 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/ComponentModel.java
 Sun Jan 11 16:49:37 2009
@@ -31,6 +31,8 @@
  */
 public class ComponentModel extends BaseModel 
 implements Serializable{
+    // Serial Version UID
+    private static final long serialVersionUID = 1L;
     // The map of datamodel of child RDCs; keyed by id 
     protected Map localMap;
     // The map of non-default configs of child RDCs; keyed by id 
@@ -59,7 +61,7 @@
     /**
      * Set the map of child RDC datamodels
      * 
-     * @param localMap - the map of child RDC datamodels
+     * @param localMap The map of child RDC datamodels
      */
     public void setLocalMap(Map localMap) {
         this.localMap = localMap;
@@ -78,7 +80,7 @@
     /**
      * Set the map of configuration file URI of child RDCs
      * 
-     * @param configMap - the map of configuration file URI of child RDCs
+     * @param configMap The map of configuration file URI of child RDCs
      */
     public void setConfigMap(Map configMap) {
         this.configMap = configMap;
@@ -87,7 +89,7 @@
     /**
      * Set the context in which this component is executing
      * 
-     * @param ctx - the JspContext
+     * @param ctx The JspContext
      */
     public void setContext(JspContext ctx) {
         this.context = ctx;
@@ -96,7 +98,7 @@
     /**
      * Set the configuration URI
      * 
-     * @param config- the configuration file URI
+     * @param newConfig The new configuration file URI
      */    
     public void setConfig(String newConfig) {
         if (!RDCUtils.isStringEmpty(newConfig)) {

Modified: 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/DialogManager.java
URL: 
http://svn.apache.org/viewvc/jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/DialogManager.java?rev=733556&r1=733555&r2=733556&view=diff
==============================================================================
--- 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/DialogManager.java
 (original)
+++ 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/DialogManager.java
 Sun Jan 11 16:49:37 2009
@@ -42,17 +42,18 @@
      * Initialization for this invocation of the doTag()
      * 
      * @param ctx the JspContext
+     * @param bodyFragment The JspFragment indicating the body of this group
      */
-    public boolean initialize(JspContext ctx, JspFragment bodyFrag) 
+    public boolean initialize(JspContext ctx, JspFragment bodyFragment) 
     throws JspException, IOException;
     
     /**
      * Collect input from the user 
      * 
      * @param ctx the JspContext
-     * @param bodyFragment the JspFragment indicating the body of this group
+     * @param bodyFragment The JspFragment indicating the body of this group
      */
-    public void collect(JspContext ctx, JspFragment bodyFrag) 
+    public void collect(JspContext ctx, JspFragment bodyFragment) 
     throws JspException, IOException;
 
     /**

Modified: 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/Grammar.java
URL: 
http://svn.apache.org/viewvc/jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/Grammar.java?rev=733556&r1=733555&r2=733556&view=diff
==============================================================================
--- 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/Grammar.java
 (original)
+++ 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/Grammar.java
 Sun Jan 11 16:49:37 2009
@@ -35,6 +35,8 @@
  */
 public class Grammar implements Serializable {
 
+    /** Serial Version UID */
+    private static final long serialVersionUID = 1L;
     /** Indicates whether this grammar is inline (or a URI reference)
      *  Default is Boolean.FALSE (URI reference) */
     private Boolean isInline;

Modified: 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/GroupModel.java
URL: 
http://svn.apache.org/viewvc/jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/GroupModel.java?rev=733556&r1=733555&r2=733556&view=diff
==============================================================================
--- 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/GroupModel.java
 (original)
+++ 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/GroupModel.java
 Sun Jan 11 16:49:37 2009
@@ -32,7 +32,9 @@
 
 public class GroupModel extends BaseModel 
     implements Serializable{
-    
+
+    // Serial Version UID
+    private static final long serialVersionUID = 1L;
     // The map of datamodel of child RDCs; keyed by id 
     protected Map localMap;
     // The object that group confirmation is outsourced to
@@ -63,7 +65,7 @@
     /**
      * Set the map of child RDC datamodels
      * 
-     * @param localMap - the map of child RDC datamodels
+     * @param localMap The map of child RDC datamodels
      */
     public void setLocalMap(Map localMap) {
         this.localMap = localMap;
@@ -81,7 +83,7 @@
     /**
      * Set the GroupConfirm
      * 
-     * @param confirm
+     * @param groupConfirm The confirmation setting for this group
      */
     public void setGroupConfirm(GroupConfirm groupConfirm) {
         this.groupConfirm = groupConfirm;

Modified: 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/GroupTag.java
URL: 
http://svn.apache.org/viewvc/jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/GroupTag.java?rev=733556&r1=733555&r2=733556&view=diff
==============================================================================
--- 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/GroupTag.java
 (original)
+++ 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/GroupTag.java
 Sun Jan 11 16:49:37 2009
@@ -143,7 +143,7 @@
     /**
      * Set the group level confirmation
      *
-     * @param Boolean confirm
+     * @param confirm The group confirmation
      */
     public void setConfirm(Boolean confirm) {
         this.confirm = confirm;

Modified: 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/IncludeFSMFragmentTag.java
URL: 
http://svn.apache.org/viewvc/jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/IncludeFSMFragmentTag.java?rev=733556&r1=733555&r2=733556&view=diff
==============================================================================
--- 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/IncludeFSMFragmentTag.java
 (original)
+++ 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/IncludeFSMFragmentTag.java
 Sun Jan 11 16:49:37 2009
@@ -61,7 +61,7 @@
     /**
      * Set the RDCTemplate
      * 
-     * @param template
+     * @param template The {...@link RDCTemplate}
      */
     public void setTemplate(RDCTemplate template) {
         this.template = template;
@@ -70,7 +70,7 @@
     /**
      * Set the PageContext
      * 
-     * @param PageContext context
+     * @param context The {...@link PageContext}
      */
     public void setContext(PageContext context) {
         this.context = context;

Modified: 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/NBestResults.java
URL: 
http://svn.apache.org/viewvc/jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/NBestResults.java?rev=733556&r1=733555&r2=733556&view=diff
==============================================================================
--- 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/NBestResults.java
 (original)
+++ 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/NBestResults.java
 Sun Jan 11 16:49:37 2009
@@ -32,7 +32,9 @@
  * @author Rahul Akolkar
  */
 public class NBestResults implements Serializable {
-    
+
+    // Serial Version UID
+    private static final long serialVersionUID = 1L;
     // Arrays containing confidence, interpretation and utterances
     // for each of the n-best results
     List confidences, interpretations, utterances;

Modified: 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/RDCTemplate.java
URL: 
http://svn.apache.org/viewvc/jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/RDCTemplate.java?rev=733556&r1=733555&r2=733556&view=diff
==============================================================================
--- 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/RDCTemplate.java
 (original)
+++ 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/RDCTemplate.java
 Sun Jan 11 16:49:37 2009
@@ -34,7 +34,9 @@
  * @author Rahul Akolkar
  */
 public class RDCTemplate extends BaseModel {
-    
+
+    // Serial Version UID
+    private static final long serialVersionUID = 1L;
     // Error messages (to be i18n'zed)
     private static final String ERR_BAD_PROP = "Did not populate " +
         " following property(ies) for RDC template instance with id \"{0}\"" +
@@ -109,7 +111,7 @@
     /**
      * Sets the bean value
      * 
-     * @param string bean
+     * @param bean The value bean
      */
     public void setBean(String bean) {
         if (bean != null) {
@@ -131,7 +133,7 @@
      * Set the tag fragment URI overriding the default FSM
      * defined in <fsm-run>
      * 
-     * @param fsmTagFragment
+     * @param fsmFragment The URI to the tag fragment
      */
     public void setFsmFragment(String fsmFragment) {
         if (fsmFragment != null) {
@@ -167,7 +169,7 @@
     /**
      * Set the dynamic attributes data received from this tag instance
      * 
-     * @param attrsMap The dynamic attributes name value map
+     * @param dynamicAttributes The dynamic attributes name value map
      */
     public void setDynamicAttributes(Map dynamicAttributes) {
         if (dynamicAttributes != null) {
@@ -182,7 +184,7 @@
      * Sets the grammar(s). The param can be an array of some combination
      * of Grammar objects and string URIs or a Grammar object or a string URI.
      * 
-     * @param grammar
+     * @param grammar The grammar to set
      */
     public void setGrammar(Object grammar) {
         Map grammarMap = new HashMap();

Modified: 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/StrutsSubmitTag.java
URL: 
http://svn.apache.org/viewvc/jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/StrutsSubmitTag.java?rev=733556&r1=733555&r2=733556&view=diff
==============================================================================
--- 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/StrutsSubmitTag.java
 (original)
+++ 
jakarta/taglibs/proper/rdc/trunk/taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/StrutsSubmitTag.java
 Sun Jan 11 16:49:37 2009
@@ -107,7 +107,7 @@
     /**
      * Set the submit URI
      * 
-     * @param String submit
+     * @param submit The submit URI
      */
     public void setSubmit(String submit) {
         this.submit = submit;
@@ -116,7 +116,7 @@
     /**
      * Set the namelist
      * 
-     * @param String namelist
+     * @param namelist The space-separated name list
      */
     public void setNamelist(String namelist) {
         this.namelist = namelist;
@@ -125,7 +125,7 @@
     /**
      * Set the clearlist
      * 
-     * @param String clearlist
+     * @param clearlist The space-separated clear list
      */
     public void setClearlist(String clearlist) {
         this.clearlist = clearlist;
@@ -134,7 +134,7 @@
     /**
      * Set the page context 
      * 
-     * @param PageContext context the supplied page context
+     * @param context The supplied page context
      */
     public void setContext(PageContext context) {
         this.context = context;
@@ -143,7 +143,7 @@
     /**
      * Set the "dialogMap" object [of the host JSP]
      * 
-     * @param LinkedHashMap the dialogMap object from the host JSP
+     * @param dialogMap The dialogMap object from the host JSP
      */
     public void setDialogMap(Map dialogMap) {
         this.dialogMap = dialogMap;



---------------------------------------------------------------------
To unsubscribe, e-mail: taglibs-dev-unsubscr...@jakarta.apache.org
For additional commands, e-mail: taglibs-dev-h...@jakarta.apache.org

Reply via email to