Javadoc updates

This commit is contained in:
lucasward
2009-04-08 20:53:20 +00:00
parent d6744b0be9
commit df2f25b1d0
13 changed files with 20 additions and 24 deletions

View File

@@ -17,11 +17,11 @@
package org.springframework.batch.item;
/**
* <p>Interface for item transformation. Given an item as input, this interface provides
* Interface for item transformation. Given an item as input, this interface provides
* an extension point which allows for the application of business logic in an item
* oriented processing scenario. It should be noted that while it's possible to return
* a different type than the one provided, it's not strictly necessary. Furthermore,
* returning null indicates that the item should not be continued to be processed.</p>
* returning null indicates that the item should not be continued to be processed.
*
* @author Robert Kasanicky
* @author Dave Syer

View File

@@ -78,6 +78,7 @@ import org.springframework.util.Assert;
* @see java.sql.Connection#close()
* @see DataSourceUtils#releaseConnection
* @see org.springframework.jdbc.support.nativejdbc.NativeJdbcExtractor
* @since 2.0
*/
public class ExtendedConnectionDataSourceProxy implements SmartDataSource, InitializingBean {

View File

@@ -33,22 +33,19 @@ import org.springframework.util.StringUtils;
/**
* {@link ItemReader} for reading database records built on top of Hibernate.
*
* It executes the HQL query when initialized iterates over the result set as
* {@link #read()} method is called, returning an object corresponding to
* current row. The query can be set directly using
* {@link #setQueryString(String)} or a named query can be used by
* {@link #setQueryName(String)}.
*
* The reader can be configured to use either {@link StatelessSession}
* <p>The reader can be configured to use either {@link StatelessSession}
* sufficient for simple mappings without the need to cascade to associated
* objects or standard hibernate {@link Session} for more advanced mappings or
* when caching is desired.
* when caching is desired. When stateful session is used it will be cleared after successful commit
* without being flushed (no inserts or updates are expected).</p>
*
* When stateful session is used it will be cleared after successful commit
* without being flushed (no inserts or updates are expected).
*
* The implementation is *not* thread-safe.
* The implementation is <b>not</b> thread-safe.
*
* @author Robert Kasanicky
* @author Dave Syer

View File

@@ -32,7 +32,7 @@ import org.springframework.util.Assert;
* and clear the session at chunk boundaries.<br/><br/>
*
* The writer is thread safe after its properties are set (normal singleton
* behaviour), so it can be used to write in multiple concurrent transactions.
* behavior), so it can be used to write in multiple concurrent transactions.
*
* @author Dave Syer
* @author Thomas Risberg

View File

@@ -23,6 +23,7 @@ import org.springframework.jdbc.core.RowMapper;
/**
* A convenient strategy for SQL updates, acting effectively as the inverse of
* {@link RowMapper}.
*
* @author Dave Syer
*
*/

View File

@@ -37,9 +37,9 @@ import org.springframework.jdbc.core.simple.SimpleJdbcTemplate;
import org.springframework.util.Assert;
/**
* {@link ItemWriter} that uses the batching features from
* <p>{@link ItemWriter} that uses the batching features from
* {@link SimpleJdbcTemplate} to execute a batch of statements for all items
* provided.<br/>
* provided.</p>
*
* The user must provide an SQL query and a special callback in the for of either
* {@link ItemPreparedStatementSetter}, or a {@link ItemSqlParameterSourceProvider}.
@@ -52,7 +52,7 @@ import org.springframework.util.Assert;
* It is expected that {@link #write(List)} is called inside a transaction.<br/>
*
* The writer is thread safe after its properties are set (normal singleton
* behaviour), so it can be used to write in multiple concurrent transactions.
* behavior), so it can be used to write in multiple concurrent transactions.
*
* @author Dave Syer
* @author Thomas Risberg

View File

@@ -38,10 +38,6 @@ import org.springframework.util.StringUtils;
* @author Rob Harrop
* @author Dave Syer
*/
/**
* @author dsyer
*
*/
public class DefaultFieldSet implements FieldSet {
private final static String DEFAULT_DATE_PATTERN = "yyyy-MM-dd";

View File

@@ -31,7 +31,7 @@ import org.springframework.util.Assert;
* {@link #read()}.<br/><br/>
*
* The implementation is thread safe after its properties are set (normal
* singleton behaviour).
* singleton behavior).
*
* @author Dave Syer
*

View File

@@ -30,7 +30,7 @@ import org.springframework.jms.core.JmsTemplate;
* {@link #write(List)}.<br/><br/>
*
* The implementation is thread safe after its properties are set (normal
* singleton behaviour).
* singleton behavior).
*
* @author Dave Syer
*
@@ -42,7 +42,7 @@ public class JmsItemWriter<T> implements ItemWriter<T> {
private JmsOperations jmsTemplate;
/**
* Setter for jms template.
* Setter for JMS template.
*
* @param jmsTemplate a {@link JmsOperations} instance
*/

View File

@@ -32,6 +32,7 @@ import org.springframework.batch.item.ItemWriter;
* The implementation is thread-safe if all delegates are thread-safe.
*
* @author Dave Syer
* @since 2.0
*/
public class ClassifierCompositeItemWriter<T> implements ItemWriter<T> {

View File

@@ -25,7 +25,7 @@ import org.springframework.util.Assert;
/**
* Composite {@link ItemProcessor} that passes the item through a sequence of
* injected <code>ItemTransformer</code>s (return value of previous
* transformation is the entry value of the next).
* transformation is the entry value of the next).<br/><br/>
*
* Note the user is responsible for injecting a chain of {@link ItemProcessor}
* s that conforms to declared input and output types.

View File

@@ -22,7 +22,7 @@ import java.util.List;
import org.springframework.batch.item.ItemWriter;
/**
* Calls a collection of ItemWriters in fixed-order sequence.
* Calls a collection of {@link ItemWriter}s in fixed-order sequence.<br/><br/>
*
* The implementation is thread-safe if all delegates are thread-safe.
*

View File

@@ -27,7 +27,7 @@ import org.springframework.jdbc.support.MetaDataAccessException;
/**
* Enum representing a database type, such as DB2 or oracle. The type also
* contains a product name, which is expected to the same as the product name
* contains a product name, which is expected to be the same as the product name
* provided by the database driver's metadata.
*
* @author Lucas Ward
@@ -53,7 +53,7 @@ public enum DatabaseType {
nameMap.put(type.getProductName(), type);
}
}
//A description is necessary due to the length of database descriptions
//A description is necessary due to the nature of database descriptions
//in metadata.
private final String productName;