[cvs] expresso commit by mtraum: fixed some javadocs
JCorporate Ltd
jcorp at jcorporate.com
Sun Feb 13 22:48:42 UTC 2005
Log Message:
-----------
fixed some javadocs
Modified Files:
--------------
expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller:
ErrorCollection.java
DefaultControllerFactory.java
Controller.java
ControllerElement.java
ControllerResponse.java
StateForm.java
DefaultForm.java
Revision Data
-------------
Index: DefaultForm.java
===================================================================
RCS file: /home/javacorp/.cvs/expresso/expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/DefaultForm.java,v
retrieving revision 1.20
retrieving revision 1.21
diff -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/DefaultForm.java -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/DefaultForm.java -u -r1.20 -r1.21
--- expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/DefaultForm.java
+++ expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/DefaultForm.java
@@ -153,7 +153,10 @@
}
/**
- *
+ * Set all of the fields using a hastable of parameters
+ *
+ * @param parameters values to set
+ * @throws ControllerException on error
*/
public synchronized void setUsingHashtableParameters(Hashtable parameters) throws ControllerException {
for (Iterator i = parameters.keySet().iterator(); i.hasNext();) {
@@ -166,7 +169,9 @@
* Returns the attribute that has been set for a particular field OR
* null if it doesn't exist.
*
+ * @param fieldName the field to retrieve the attribute of
* @throws ControllerException if fieldName is blank.
+ * @return Object containing the field's attribute
*/
public Object getAttribute(String fieldName) throws ControllerException {
if (formAttributes == null) {
@@ -183,6 +188,8 @@
/**
* Returns the attributes Hashtable.
+ *
+ * @return Hashtable of all attributes
*/
public Hashtable getAttributes() {
@@ -238,7 +245,6 @@
* <code>null</code> or an <code>ActionErrors</code> object with no
* recorded error messages.
*
- * @param mapping The mapping used to select this instance.
* @param request The servlet request we are processing.
* @return ActionErrors containing validation errors.
*/
@@ -254,7 +260,9 @@
/**
* Get the state requested by the transition button in the form
- * @param params the hashtable of parameters to parse
+ *
+ * @param request the servlet request we are processing
+ *
* @return String
* @throws ControllerException
*/
@@ -390,6 +398,8 @@
* @param page This in conjunction with the page property of a
* <code>Field<code> can control the processing of fields. If the field's
* page is less than or equal to this page value, it will be processed.
+ *
+ * @return Validator the initialized Validator
*/
public Validator initValidator(String key,
Object bean,
Index: ControllerResponse.java
===================================================================
RCS file: /home/javacorp/.cvs/expresso/expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ControllerResponse.java,v
retrieving revision 1.56
retrieving revision 1.57
diff -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ControllerResponse.java -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ControllerResponse.java -u -r1.56 -r1.57
--- expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ControllerResponse.java
+++ expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ControllerResponse.java
@@ -1547,7 +1547,11 @@
/* addBlock(Block) */
/**
+ * Add and error message to the response
+ *
* @param errorMessage
+ *
+ * @throws ControllerException on error
*/
public void addError(String errorMessage) throws ControllerException {
ErrorCollection errs = getErrors();
@@ -1566,6 +1570,7 @@
* @param errorMessage key to error msg found in message bundle
* @param arg a replacement value to use in ${} replacement template
* @see com.jcorporate.expresso.core.i18n.MessageBundle#getString(java.lang.String, java.lang.Object[])
+ * @throws ControllerException on error
*/
public void addError(String errorMessage, Object arg) throws ControllerException {
ErrorCollection errs = getErrors();
@@ -1585,6 +1590,8 @@
* @param errorMessage key to error msg found in message bundle
* @param args an array of replacement value to use in ${} replacement templates
* @see com.jcorporate.expresso.core.i18n.MessageBundle#getString(java.lang.String, java.lang.Object[])
+ *
+ * @throws ControllerException on error
*/
public void addError(String errorMessage, Object[] args) throws ControllerException {
ErrorCollection errs = getErrors();
@@ -1880,6 +1887,7 @@
/**
* determine whether response has errors of the particular label
*
+ * @param label the label to search in for errors
* @return true if response has errors of the particular label
* @throws ControllerException if there is a problem
*/
@@ -2262,6 +2270,8 @@
/**
* return raw key, without running through msg bundle string translation--useful for when 'cloning' in Transition
+ *
+ * @return String the title key
*/
public String getTitleKey() {
return title;
Index: ControllerElement.java
===================================================================
RCS file: /home/javacorp/.cvs/expresso/expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ControllerElement.java,v
retrieving revision 1.29
retrieving revision 1.30
diff -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ControllerElement.java -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ControllerElement.java -u -r1.29 -r1.30
--- expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ControllerElement.java
+++ expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ControllerElement.java
@@ -629,7 +629,7 @@
/**
* Retrieve the iterator to all tested objects.
*
- * @return
+ * @return Iterator nested elements
*/
public Iterator getNestedIterator() {
return getNested().iterator();
@@ -956,6 +956,8 @@
/**
* Return a Map of all nested elements keyed by controllerElement name.
* Useful for JSTL iteration of the Map.
+ *
+ * @return Map nested elements
*/
public Map getNestedMap() {
if (mappedNested == null) {
Index: ErrorCollection.java
===================================================================
RCS file: /home/javacorp/.cvs/expresso/expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ErrorCollection.java,v
retrieving revision 1.21
retrieving revision 1.22
diff -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ErrorCollection.java -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ErrorCollection.java -u -r1.21 -r1.22
--- expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ErrorCollection.java
+++ expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/ErrorCollection.java
@@ -158,6 +158,7 @@
* Adds an error with an array of arguments
*
* @param errorMessage java.lang.String
+ * @param args the arguements to be added to the errorMessage
*/
public void addError(String errorMessage, Object[] args) {
if (!hasErrorMessage(errorMessage)) {
@@ -170,7 +171,7 @@
* Checks to see if a particular error message exists in the current collection
*
* @param errorMessage
- * @return
+ * @return boolean if the error message exists
*/
private boolean hasErrorMessage(String errorMessage) {
String oneMessage = null;
@@ -273,9 +274,6 @@
}
- /**
- *
- */
public Iterator getErrors(String label) {
return get(label);
}
@@ -284,6 +282,8 @@
* Allows us to retract an error if at one point in the code
* we decide we don't actually want that error, but some previous parts
* were too isolated to make this decision.
+ *
+ * @param label the label whcih keys a collection of errors
*/
public void removeError(String label) {
for (Iterator i = get(label); i.hasNext();) {
@@ -295,6 +295,8 @@
/**
* clone method
+ *
+ * @return Object the cloned object
*/
public Object clone()
throws CloneNotSupportedException {
Index: Controller.java
===================================================================
RCS file: /home/javacorp/.cvs/expresso/expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/Controller.java,v
retrieving revision 1.109
retrieving revision 1.110
diff -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/Controller.java -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/Controller.java -u -r1.109 -r1.110
--- expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/Controller.java
+++ expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/Controller.java
@@ -936,6 +936,9 @@
/**
* recreate requested URL; never null, though could be empty string
+ *
+ * @param req the servlet request
+ * @return String the request URL
*/
protected String getRequestURL(HttpServletRequest req) {
String origUrl = StringUtil.notNull(req.getRequestURI());
Index: StateForm.java
===================================================================
RCS file: /home/javacorp/.cvs/expresso/expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/StateForm.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/StateForm.java -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/StateForm.java -u -r1.9 -r1.10
--- expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/StateForm.java
+++ expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/StateForm.java
@@ -73,6 +73,9 @@
public interface StateForm {
/**
* method prototype so it can be called from an external State *RD* Mon Jul 27 2004
+ *
+ * @param request the servlet request
+ * @return ErrorCollection a collection of errors
*/
public ErrorCollection validate(ControllerRequest request);
}
Index: DefaultControllerFactory.java
===================================================================
RCS file: /home/javacorp/.cvs/expresso/expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/DefaultControllerFactory.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/DefaultControllerFactory.java -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/DefaultControllerFactory.java -u -r1.9 -r1.10
--- expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/DefaultControllerFactory.java
+++ expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller/DefaultControllerFactory.java
@@ -93,6 +93,9 @@
/**
* Retrieve the Action controller that matches the class name
+ *
+ * @param className the class name of the Action controller to retrieve
+ * @return Controller the Action controller
*/
public synchronized Controller getController(String className)
throws ControllerException {
@@ -102,6 +105,10 @@
/**
* Retrieve the Action controller that matches the class name
* The <code>moduleName</code> is ignored for this implementation.
+ *
+ * @param moduleName ignored for this implementation
+ * @param className the class name of the Action controller to retrieve
+ * @return Controller the Action controller
*/
public synchronized Controller getController(String moduleName, String className)
throws ControllerException {
@@ -118,6 +125,9 @@
/**
* Retrieve the Action controller that matches the class name
* The Struts 1.1 modules are ignored for this implementation.
+ *
+ * @param request the servlet request
+ * @return Controller the controller referenced by the request
*/
public synchronized Controller getController(ControllerRequest request)
throws ControllerException {
More information about the cvs
mailing list