You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by dg...@apache.org on 2003/06/10 05:34:42 UTC
cvs commit: jakarta-commons-sandbox/mapper/src/share/org/apache/commons/mapper MapperFactory.java Mapper.java
dgraham 2003/06/09 20:34:42
Modified: mapper/src/share/org/apache/commons/mapper/jdbc
JdbcHelper.java JdbcMapperFactory.java
JdbcMapper.java
mapper/src/share/org/apache/commons/mapper
MapperFactory.java Mapper.java
Log:
Fixed javadoc warnings.
Revision Changes Path
1.3 +4 -4 jakarta-commons-sandbox/mapper/src/share/org/apache/commons/mapper/jdbc/JdbcHelper.java
Index: JdbcHelper.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/mapper/src/share/org/apache/commons/mapper/jdbc/JdbcHelper.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- JdbcHelper.java 10 Jun 2003 02:39:35 -0000 1.2
+++ JdbcHelper.java 10 Jun 2003 03:34:41 -0000 1.3
@@ -229,7 +229,7 @@
* @param resultFactory
* @return A list of objects generated by the resultFactory.
* @throws MapperException
- * @see executeQuery(String, StatementPreparer, Object, ResultObjectFactory)
+ * @see #executeQuery(String, StatementPreparer, Object, ResultObjectFactory)
*/
public List executeQuery(
String sql,
@@ -245,7 +245,7 @@
* @param resultFactory
* @return A list of objects generated by the resultFactory.
* @throws MapperException
- * @see executeQuery(String, StatementPreparer, Object, ResultObjectFactory)
+ * @see #executeQuery(String, StatementPreparer, Object, ResultObjectFactory)
*/
public List executeQuery(String sql, ResultObjectFactory resultFactory)
throws MapperException {
@@ -257,7 +257,7 @@
* Connection.
* @param query
* @param column
- * @return
+ * @return The value of the selected field.
* @throws MapperException
*/
public String getField(String query, String column) throws MapperException {
@@ -408,7 +408,7 @@
}
/**
- * Converts an integer to a boolean. 0 is false, anything else is true.
+ * Converts an integer to a boolean. Zero is false, anything else is true.
*/
public boolean toBoolean(int value) {
return (value == 0) ? false : true;
1.3 +0 -4 jakarta-commons-sandbox/mapper/src/share/org/apache/commons/mapper/jdbc/JdbcMapperFactory.java
Index: JdbcMapperFactory.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/mapper/src/share/org/apache/commons/mapper/jdbc/JdbcMapperFactory.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- JdbcMapperFactory.java 10 Jun 2003 02:39:35 -0000 1.2
+++ JdbcMapperFactory.java 10 Jun 2003 03:34:41 -0000 1.3
@@ -102,8 +102,6 @@
* will use for queries.
* @param mappers Any map containing domain class names as the keys and
* mapper class names as the values.
- * @return JdbcMapperFactory an initialized factory containing the mappings in
- * the given Map.
* @throws IllegalArgumentException if there is a problem finding the mapped classes.
*/
public JdbcMapperFactory(DataSource ds, Map mappers) {
@@ -118,8 +116,6 @@
* mapper class names as the values.
* @param queries A map of query names to SQL queries to pass to the mappers.
* The keys in this map are case-insensitive.
- * @return JdbcMapperFactory an initialized factory containing the mappings in
- * the given Map.
* @throws IllegalArgumentException if there is a problem finding the mapped classes.
*/
public JdbcMapperFactory(DataSource ds, Map mappers, Map queries) {
1.3 +6 -6 jakarta-commons-sandbox/mapper/src/share/org/apache/commons/mapper/jdbc/JdbcMapper.java
Index: JdbcMapper.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/mapper/src/share/org/apache/commons/mapper/jdbc/JdbcMapper.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- JdbcMapper.java 10 Jun 2003 02:39:35 -0000 1.2
+++ JdbcMapper.java 10 Jun 2003 03:34:41 -0000 1.3
@@ -120,26 +120,26 @@
/**
* @throws UnsupportedOperationException
- * @see org.apache.commons.mapper.Mapper#findByPrimaryKey(MappedObject)
+ * @see org.apache.commons.mapper.Mapper#findByUniqueId(Object)
*/
- public Object findByUniqueID(Object objectWithKeyValues)
+ public Object findByUniqueId(Object id)
throws MapperException {
throw new UnsupportedOperationException("Find by unique ID not supported.");
}
/**
* @throws UnsupportedOperationException
- * @see org.apache.commons.mapper.Mapper#remove(MappedObject)
+ * @see org.apache.commons.mapper.Mapper#delete(Object)
*/
- public void delete(Object domainObject) throws MapperException {
+ public void delete(Object object) throws MapperException {
throw new UnsupportedOperationException("Delete not supported.");
}
/**
* @throws UnsupportedOperationException
- * @see org.apache.commons.mapper.Mapper#update(MappedObject)
+ * @see org.apache.commons.mapper.Mapper#update(Object)
*/
- public void update(Object domainObject) throws MapperException {
+ public void update(Object object) throws MapperException {
throw new UnsupportedOperationException("Update not supported.");
}
1.4 +3 -5 jakarta-commons-sandbox/mapper/src/share/org/apache/commons/mapper/MapperFactory.java
Index: MapperFactory.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/mapper/src/share/org/apache/commons/mapper/MapperFactory.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- MapperFactory.java 10 Jun 2003 03:17:55 -0000 1.3
+++ MapperFactory.java 10 Jun 2003 03:34:41 -0000 1.4
@@ -105,8 +105,6 @@
* Create a new MapperFactory with the mappings contained in the given Map.
* @param Map any map containing logical names (often domain class names) as
* the keys and mapper class names as the values.
- * @return MapperFactory an initialized factory containing the mappings in the
- * given Map.
* @throws IllegalArgumentException if there is a problem finding the mapped
* classes.
*/
1.3 +1 -1 jakarta-commons-sandbox/mapper/src/share/org/apache/commons/mapper/Mapper.java
Index: Mapper.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/mapper/src/share/org/apache/commons/mapper/Mapper.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Mapper.java 10 Jun 2003 02:39:35 -0000 1.2
+++ Mapper.java 10 Jun 2003 03:34:41 -0000 1.3
@@ -88,7 +88,7 @@
public interface Mapper {
/**
- * Create the given object in a persistent data store (ie. an SQL insert). The
+ * Create the given object in a persistent data store. The
* Mapper should document what type of Object is expected.
* @return Object the created object's unique id.
* @throws MapperException
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org