craigmcc 2002/11/22 18:45:56 Modified: scaffold/src/java/org/apache/commons/scaffold/http HttpClient.java scaffold/src/java/org/apache/commons/scaffold/sql ConnectionAdaptor.java ResultSetUtils.java StatementUtils.java StorageBeanBase.java scaffold/src/java/org/apache/commons/scaffold/util ProcessBeanBase.java ProcessResult.java ProcessResultBase.java ResultList.java Scroller.java ScrollerBean.java StorageBean.java Log: First round of Javadoc whining cleanups -- 32 more to go. No functionality changes. JDK 1.4 is much pickier about this kind of thing. Revision Changes Path 1.2 +7 -7 jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/http/HttpClient.java Index: HttpClient.java =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/http/HttpClient.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- HttpClient.java 14 Aug 2002 17:50:28 -0000 1.1 +++ HttpClient.java 23 Nov 2002 02:45:55 -0000 1.2 @@ -25,11 +25,11 @@ * Retrieve indicated page, returning headers and * page content. * - * @params host - * @params port - * @params requestLine - * @params requestHeaders - * @params content + * @param host + * @param port + * @param requestLine + * @param requestHeaders + * @param content * @exception Catches IOException and UnknownHostException, * and returns messages in content. * @author Marty Hall 1.2 +6 -6 jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/sql/ConnectionAdaptor.java Index: ConnectionAdaptor.java =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/sql/ConnectionAdaptor.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- ConnectionAdaptor.java 14 Aug 2002 17:51:42 -0000 1.1 +++ ConnectionAdaptor.java 23 Nov 2002 02:45:55 -0000 1.2 @@ -123,7 +123,7 @@ /** * Field to store singleton reference to default datasource. * - * @todo Add Map to store reference to other datasoruces. + * TODO: Add Map to store reference to other datasoruces. */ protected static DataSource datasource; @@ -135,9 +135,9 @@ * * @param key The attribute name for the resource. * If null is passed, null is returned. - * @returns null or the datasource object related to "key" + * @return null or the datasource object related to "key" * - * @todo Add cache to store references to the datasources by key. + * TODO: Add cache to store references to the datasources by key. */ protected DataSource getDataSource(String key) throws SQLException { @@ -175,7 +175,7 @@ * The default datasource object is cached and reused in subsequent * calls. * - * @returns JDBC connection from resource layer. + * @return JDBC connection from resource layer. * @exception SQLException on SQL or other errors. May wrap other * exceptions depending on implementation. Will not return null. */ @@ -202,7 +202,7 @@ * getResource() ["DATASOURCE"]. * Will not return null. * - * @returns JDBC connection from resource layer. + * @return JDBC connection from resource layer. * @exception SQLException on SQL or other errors. May wrap * other exceptions depending on implementation. * @param resource An attribute name for the resource to use for 1.5 +2 -2 jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/sql/ResultSetUtils.java Index: ResultSetUtils.java =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/sql/ResultSetUtils.java,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- ResultSetUtils.java 21 Nov 2002 02:07:16 -0000 1.4 +++ ResultSetUtils.java 23 Nov 2002 02:45:55 -0000 1.5 @@ -356,7 +356,7 @@ * @param target An instance of the bean to populate * @exception SQLException if an exception is thrown while setting * property values, populating the bean, or accessing the ResultSet - * @returns True if resultSet contained a next element + * @return True if resultSet contained a next element */ public static boolean getElement(Object target, ResultSet resultSet) throws SQLException { 1.6 +5 -5 jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/sql/StatementUtils.java Index: StatementUtils.java =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/sql/StatementUtils.java,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- StatementUtils.java 31 Oct 2002 14:27:08 -0000 1.5 +++ StatementUtils.java 23 Nov 2002 02:45:55 -0000 1.6 @@ -507,7 +507,7 @@ * @param parameters The replaceable parameters to use with * command. * @exception SQLException if SQL error occurs - * @returns True if element is found + * @return True if element is found */ public static final boolean getElement( String resource, @@ -554,7 +554,7 @@ * @param command The SQL statement to prepare and execute. * @param key The replaceable parameter to use with LIKE. * @exception SQLException if SQL error occurs - * @returns True if element is found + * @return True if element is found */ public static final boolean getElement( String resource, @@ -580,7 +580,7 @@ * @param command The SQL statement to prepare and execute. * @param key The replaceable parameter to use with LIKE. * @exception SQLException if SQL error occurs - * @returns True if element is found + * @return True if element is found */ public static final boolean getElement( String resource, @@ -606,7 +606,7 @@ * @param command The SQL statement to prepare and execute. * @param key The replaceable parameter to use with LIKE. * @exception SQLException if SQL error occurs - * @returns True if element is found + * @return True if element is found */ public static final boolean getElement( String resource, 1.15 +12 -12 jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/sql/StorageBeanBase.java Index: StorageBeanBase.java =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/sql/StorageBeanBase.java,v retrieving revision 1.14 retrieving revision 1.15 diff -u -r1.14 -r1.15 --- StorageBeanBase.java 21 Nov 2002 02:07:16 -0000 1.14 +++ StorageBeanBase.java 23 Nov 2002 02:45:55 -0000 1.15 @@ -88,17 +88,17 @@ * resultset if you like * </UL> * - * @todo Refactor recycle,restore,delete to use common util method - * @todo Javadocs for new classes - * @todo Use reflection to read parameter key and make array from + * TODO: Refactor recycle,restore,delete to use common util method + * TODO: Javadocs for new classes + * TODO: Use reflection to read parameter key and make array from * that. - * @todo Check for key.paramlist then paramlist. - * @todo Permit each subclass to have its own properties (collection + * TODO: Check for key.paramlist then paramlist. + * TODO: Permit each subclass to have its own properties (collection * of properties, like Struts Actions). - * @todo Switch to CommandStore (or eliminate that object if not + * TODO: Switch to CommandStore (or eliminate that object if not * needed). - * @todo Add properties to manage optimistic locking - * @todo Change from BeanUtil.populate to copyProperties in 1.1 + * TODO: Add properties to manage optimistic locking + * TODO: Change from BeanUtil.populate to copyProperties in 1.1 * version. * @author Ted Husted * @author OK State DEQ @@ -714,7 +714,7 @@ * Check to see if another modified timetamp * matches the one for this instance. * Returns true if the timestamps match. - * @returns true if the timestamps match. + * @return true if the timestamps match. * @param edited The new edited timestamp. */ public boolean isCurrent(Timestamp modified) { @@ -859,7 +859,7 @@ * Otherwise, an existing object is updated. * @return ProcessResult with messages and this object as data * @exception ResourceException if data access error occurs - @ @parameters The properties to use with operation + * @param parameters The properties to use with operation * */ public Object store(Object parameters) throws Exception { @@ -1075,7 +1075,7 @@ * @param parameters The map or other object to use with this * operation * @throws ParameterException if article not found in parameters - @ @throws ResourceException if SQLException or other data exception + * @throws ResourceException if SQLException or other data exception */ public Object restore(Object parameters) throws Exception { 1.8 +3 -3 jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ProcessBeanBase.java Index: ProcessBeanBase.java =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ProcessBeanBase.java,v retrieving revision 1.7 retrieving revision 1.8 diff -u -r1.7 -r1.8 --- ProcessBeanBase.java 21 Nov 2002 02:06:16 -0000 1.7 +++ ProcessBeanBase.java 23 Nov 2002 02:45:55 -0000 1.8 @@ -61,7 +61,7 @@ * by the REMOTE_ADDR CGI variable, or * ServletRequest.getRemoteAddr(). * NOTE: <b>not implemented; returns 0</b>. - * @returns An Integer value based on RemoteAddr string. + * @return An Integer value based on RemoteAddr string. */ public void setRemoteAddr(String remoteAddr) { @@ -77,7 +77,7 @@ * by the REMOTE_ADDR CGI variable, or * ServletRequest.getRemoteAddr(). * NOTE: <b>not implemented; returns zeros.</b> - * @returns An Integer value based on RemoteAddr string. + * @return An Integer value based on RemoteAddr string. */ public String getRemoteAddr() { 1.2 +11 -11 jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ProcessResult.java Index: ProcessResult.java =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ProcessResult.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- ProcessResult.java 14 Aug 2002 17:52:18 -0000 1.1 +++ ProcessResult.java 23 Nov 2002 02:45:55 -0000 1.2 @@ -71,7 +71,7 @@ * Return the single-form state: * list of 0 or more records=FALSE, exactly one record=TRUE. * - * @returns True if this is a single record + * @return True if this is a single record */ public boolean isSingleForm(); @@ -105,7 +105,7 @@ /** * Return the data object. * - * @returns The data object + * @return The data object */ public Object getData(); @@ -121,7 +121,7 @@ /** * Return whether data object has been set. * - * @returns True if this result contains a data object + * @return True if this result contains a data object */ public boolean isData(); @@ -132,7 +132,7 @@ * This allows processes to be combined on the business tier and * returned to controller as a single operation. * - * @returns True if this ProcessResult contains other ProcessResults + * @return True if this ProcessResult contains other ProcessResults * objects */ public boolean isAggregate(); @@ -149,7 +149,7 @@ /** * Return the messages list. * - * @returns The message list + * @return The message list */ public List getMessages(); @@ -157,7 +157,7 @@ /** * Return whether there are any messages queued. * - * @returns True if there are messages queued. + * @return True if there are messages queued. */ public boolean isMessages(); @@ -166,7 +166,7 @@ * Add a message to the list. * Instantiate messages if it does not already exist. * - * @returns True if message added. + * @return True if message added. */ public boolean addMessage(Object message); @@ -177,7 +177,7 @@ * * @see <code>setDispatchPath()</code> * - * @returns The dispatch advice + * @return The dispatch advice */ public String getDispatch(); @@ -191,7 +191,7 @@ /** * Return whether dispatch advice has been set. * - * @returns True if dispatch advice has been set. + * @return True if dispatch advice has been set. */ public boolean isDispatch(); @@ -200,7 +200,7 @@ * Return whether dispatch advice is suppose to be a * true path or a logical name (e.g. ActionForward) * - * @returns True if dispatch advice is an actual path + * @return True if dispatch advice is an actual path */ public boolean isDispatchPath(); 1.4 +11 -11 jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ProcessResultBase.java Index: ProcessResultBase.java =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ProcessResultBase.java,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- ProcessResultBase.java 18 Oct 2002 20:45:49 -0000 1.3 +++ ProcessResultBase.java 23 Nov 2002 02:45:55 -0000 1.4 @@ -82,7 +82,7 @@ * Return the single-form state: * list of 0 or more records=FALSE, exactly one record=TRUE. * - * @returns True if this is a single record + * @return True if this is a single record */ public boolean isSingleForm() { return this.singleForm; @@ -136,7 +136,7 @@ /** * Return the data object. * - * @returns The data object + * @return The data object */ public Object getData() { return this.data; @@ -156,7 +156,7 @@ /** * Return whether data object has been set. * - * @returns True if this result contains a data object + * @return True if this result contains a data object */ public boolean isData() { return (getData()!=null); @@ -175,7 +175,7 @@ * This allows processes to be combined on the business tier and * returned to controller as a single operation. * - * @returns True if this ProcessResult contains other ProcessResults + * @return True if this ProcessResult contains other ProcessResults * objects */ public boolean isAggregate() { @@ -202,7 +202,7 @@ /** * Return whether there are any messages queued. * - * @returns True if there are messages queued. + * @return True if there are messages queued. */ public boolean isMessages() { @@ -219,7 +219,7 @@ * Add a message to the list. * Instantiate messages if it does not already exist. * - * @returns True if message added. + * @return True if message added. */ public boolean addMessage(Object message) { return getMessages().add(message); @@ -229,7 +229,7 @@ /** * Return the messages list (an ArrayList). * - * @returns The message list + * @return The message list */ public List getMessages() { return (List) this.messages; @@ -258,7 +258,7 @@ * * @see <code>setDispatchPath()</code> * - * @returns The dispatch advice + * @return The dispatch advice */ public String getDispatch() { return (this.dispatch); @@ -278,7 +278,7 @@ /** * Return whether dispatch advice has been set. * - * @returns True if dispatch advice has been set. + * @return True if dispatch advice has been set. */ public boolean isDispatch() { return (getDispatch()!=null); @@ -295,7 +295,7 @@ * Return whether dispatch advice is suppose to be a * path or a token (e.g. ActionForward name) * - * @returns True if dispatch advice is a URI + * @return True if dispatch advice is a URI */ public boolean isDispatchPath() { return this.dispatchPath; 1.4 +5 -5 jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ResultList.java Index: ResultList.java =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ResultList.java,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- ResultList.java 18 Oct 2002 20:45:49 -0000 1.3 +++ ResultList.java 23 Nov 2002 02:45:55 -0000 1.4 @@ -30,7 +30,7 @@ /** * Return the result list - * @returns the result list + * @return the result list */ public List getResult(); @@ -68,7 +68,7 @@ * Convenience method for maintaining a counter * that can be shared among multiple components * in some presentation systems (e.g, Tiles). - * @returns The next counter value + * @return The next counter value */ public int getCounter(); @@ -118,7 +118,7 @@ * Return the displayName map (a HashMap). * These are localized titles for the * properties names in the result list. - * @returns the displayName list + * @return the displayName list */ public Map getDisplayName(); @@ -217,7 +217,7 @@ /** * Returns true if this collection contains all of the elements in the * specified collection. - * @returns true if this collection contains all of the elements in the + * @return true if this collection contains all of the elements in the * specified collection */ public boolean containsAll(Collection c); 1.5 +18 -18 jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/Scroller.java Index: Scroller.java =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/Scroller.java,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- Scroller.java 28 Oct 2002 19:45:57 -0000 1.4 +++ Scroller.java 23 Nov 2002 02:45:55 -0000 1.5 @@ -35,7 +35,7 @@ /** - * The maximum to return with a scrolling list., + * The maximum to return with a scrolling list. */ public static final int SCROLL_ROWS = 20; @@ -67,7 +67,7 @@ /** * Return from. - * @returns The form value. + * @return The form value. */ public int getFrom() { return(this.from); @@ -91,7 +91,7 @@ /** * Return thru. - * @returns The form value. + * @return The form value. */ public int getThru() { return(this.thru); @@ -115,7 +115,7 @@ /** * Return prev. - * @returns The prev value. + * @return The prev value. */ public int getPrev() { return(this.prev); @@ -141,7 +141,7 @@ /** * Return next. - * @returns The next value. + * @return The next value. */ public int getNext() { return(this.next); @@ -166,7 +166,7 @@ /** * Return limit. - * @returns The limit value. + * @return The limit value. */ public int getLimit() { return(this.limit); @@ -174,7 +174,7 @@ /** - * The actual number of entries to fetch (e.g. length or limit). + * The actual number of entries to fetch (eg length or limit). */ protected int entries = 0; @@ -190,7 +190,7 @@ /** * Return entries. - * @returns The entries value. + * @return The entries value. */ public int getEntries() { return(this.entries); @@ -215,7 +215,7 @@ /** * Return count. - * @returns The count value. + * @return The count value. */ public int getCount() { return(this.count); @@ -239,7 +239,7 @@ /** * Return parameters. - * @returns The parameters value. + * @return The parameters value. */ public Map getParameters() { return(this.parameters); @@ -268,7 +268,7 @@ /** * Return parameters as a query string for use with a URI. - * @returns query string + * @return query string */ public String getQueryString(String uri) { @@ -279,7 +279,7 @@ /** * Return parameters as a series of hidden HTML fields. - * @returns parameters as a series of hidden HTML fields. + * @return parameters as a series of hidden HTML fields. */ public String getHiddenFields() { @@ -296,7 +296,7 @@ * * Convenience method to return one less than from * - * @returns The offset for this query + * @return The offset for this query */ public int getOffset() { int from = getFrom(); @@ -306,7 +306,7 @@ /** * Return page number for given entry. - * @returns The number of pages + * @return The number of pages */ public int getPage(int thru) { @@ -322,7 +322,7 @@ /** * Return current page number - * @returns The number of pages + * @return The number of pages */ public int getPage() { @@ -332,7 +332,7 @@ /** * Return number of pages. - * @returns The number of pages + * @return The number of pages */ public int getPages() { @@ -342,7 +342,7 @@ /** * Return first entry for given page. - * @returns first entry for given page + * @return first entry for given page */ public int getOffsetForPage(int page) { 1.4 +18 -18 jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ScrollerBean.java Index: ScrollerBean.java =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/ScrollerBean.java,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- ScrollerBean.java 4 Nov 2002 23:29:05 -0000 1.3 +++ ScrollerBean.java 23 Nov 2002 02:45:55 -0000 1.4 @@ -20,7 +20,7 @@ /** * The relative position of the first entry in this set. - * @returns the position to start this set + * @return the position to start this set */ public Integer getScrollFrom(); @@ -30,14 +30,14 @@ /** * The number of entries before the first entry in the set * (One less than scrollFrom) [0]. - * @returns Offset to next entry + * @return Offset to next entry */ public Integer scrollOffset(); /** * The number of entries to return [Scroller.SCROLL_ROWS]. - * @returns Entries per page. + * @return Entries per page. */ public int scrollRows(); @@ -46,18 +46,18 @@ * Returns the String to use to retrieve the * appropriate query to count the entries matching this search. * Must be overridden or provide functionality. - * @returns Value of count key + * @return Value of count key */ public String countKey(); /** * Returns whether this search takes a parameter - * (e.g. primary key) [false]. + * (eg primary key) [false]. * Override this method to return true and * <code>getParameter</code> to return the * required parameter. - * @returns True if this search uses a parameter + * @return True if this search uses a parameter */ public boolean hasParameter(); @@ -68,7 +68,7 @@ * query or (if hasParameter==false) a description * of what the search returns. * Must be overridden or provide functionality. - * @returns Value of search parameter + * @return Value of search parameter */ public Object searchValue(); @@ -78,7 +78,7 @@ * operator so that other methods know to * wrap <code>searchValue</code> in a call to * <code>like</code> [false]. - * @returns True if this search uses the LIKE operator + * @return True if this search uses the LIKE operator */ public boolean isLike(); @@ -88,7 +88,7 @@ * The default behavior returns a "like" search count * of entries matching the searchKey. * Override to provide functionality. - * @returns total entries + * @return total entries * @exception May throw an exception on data access error */ public int entryCount() throws ResourceException; @@ -98,7 +98,7 @@ * Returns the String to use to retrieve the * appropriate query for this search. * Must be overridden or provide functionality. - * @returns Value of command key + * @return Value of command key */ public String commandKey(); @@ -108,7 +108,7 @@ * with the <code>searchValue</code>. * Default method returns null. * Must be overridden or provide functionality. - * @returns The search property + * @return The search property */ public String searchProperty(); @@ -119,7 +119,7 @@ * descriptive legend. * Default method returns <code>searchProperty</code>. * Must be overridden or provide functionality. - * @returns The label for the search property + * @return The label for the search property */ public String searchLabel(); @@ -134,7 +134,7 @@ * Returns the message token for an empty result * [Tokens.DATA_ACCESS_EMPTY]. * May be used when isFailOnEmpty is true. - * @returns Message token for an empty result. + * @return Message token for an empty result. */ public String tokenEmptyMessage(); @@ -143,7 +143,7 @@ * Returns the dispatch token for an empty result * [Tokens.FAILURE]. * May be used when isFailOnEmpty is true. - * @returns Message token for an empty result. + * @return Message token for an empty result. */ public String tokenEmptyDispatch(); @@ -151,7 +151,7 @@ /** * Return the array of parameters needed to select the * entries for this set. - * @parameter The additional parameter needed to select + * @param parameter The additional parameter needed to select * this set, if any. */ public Object[] scrollerParams(String parameter); @@ -165,7 +165,7 @@ * when <code>isParameter</code> is false. * @param target Bean to use for entries * @param parameter Value to use to match entries - * @returns Collection with the result of the search + * @return Collection with the result of the search */ public Collection result(Object target, Object parameter) throws ResourceException; @@ -176,7 +176,7 @@ * current starting point (getScrollFrom), * the default limit (set.SCROLL_ROWS), * and current count from Access (countCurrent). - * @returns new Scroller using current and default settings. + * @return new Scroller using current and default settings. * @exception ResourceException on data access error */ public Scroller newScroller(int entries) throws ResourceException; 1.8 +4 -4 jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/StorageBean.java Index: StorageBean.java =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/scaffold/src/java/org/apache/commons/scaffold/util/StorageBean.java,v retrieving revision 1.7 retrieving revision 1.8 diff -u -r1.7 -r1.8 --- StorageBean.java 21 Nov 2002 02:06:16 -0000 1.7 +++ StorageBean.java 23 Nov 2002 02:45:55 -0000 1.8 @@ -58,9 +58,9 @@ * obtain the desired properties (columns) as one or more * SQL commands. * - * @todo Multiple queries in a command - * @todo Parameters in command file - * @todo CommandStore objects + * TODO: Multiple queries in a command + * TODO: Parameters in command file + * TODO: CommandStore objects * @author Ted Husted * @author OK State DEQ * @author WXXI Public Broadcasting Council
-- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>