Update javadoc to remove javadoc warnings
This commit is contained in:
@@ -52,6 +52,7 @@ public interface ItemReader<T> {
|
||||
* with the input data. Assume potentially transient, so subsequent calls to
|
||||
* read might succeed.
|
||||
* @throws Exception if an there is a non-specific error.
|
||||
* @return T the item to be processed
|
||||
*/
|
||||
T read() throws Exception, UnexpectedInputException, ParseException, NonTransientResourceException;
|
||||
|
||||
|
||||
@@ -30,7 +30,9 @@ public interface ItemStream {
|
||||
|
||||
/**
|
||||
* Open the stream for the provided {@link ExecutionContext}.
|
||||
*
|
||||
*
|
||||
* @param executionContext current step's {@link org.springframework.batch.item.ExecutionContext}. Will be the
|
||||
* executionContext from the last run of the step on a restart.
|
||||
* @throws IllegalArgumentException if context is null
|
||||
*/
|
||||
void open(ExecutionContext executionContext) throws ItemStreamException;
|
||||
|
||||
@@ -41,7 +41,8 @@ public interface ItemWriter<T> {
|
||||
/**
|
||||
* Process the supplied data element. Will not be called with any null items
|
||||
* in normal operation.
|
||||
*
|
||||
*
|
||||
* @param items items to be written
|
||||
* @throws Exception if there are errors. The framework will catch the
|
||||
* exception and convert or rethrow it as appropriate.
|
||||
*/
|
||||
|
||||
@@ -117,7 +117,7 @@ public class JdbcBatchItemWriter<T> implements ItemWriter<T>, InitializingBean {
|
||||
/**
|
||||
* Public setter for the data source for injection purposes.
|
||||
*
|
||||
* @param dataSource
|
||||
* @param dataSource {@link javax.sql.DataSource} to use for querying against
|
||||
*/
|
||||
public void setDataSource(DataSource dataSource) {
|
||||
if (namedParameterJdbcTemplate == null) {
|
||||
|
||||
@@ -29,7 +29,7 @@ public interface RecordCallbackHandler {
|
||||
/**
|
||||
* Execute operations on the supplied record.
|
||||
*
|
||||
* @param attributes
|
||||
* @param attributes represents the record
|
||||
*/
|
||||
void handleRecord(LdapAttributes attributes);
|
||||
|
||||
|
||||
@@ -15,12 +15,6 @@
|
||||
*/
|
||||
package org.springframework.batch.item.mail.javamail;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Map.Entry;
|
||||
|
||||
import javax.mail.internet.MimeMessage;
|
||||
|
||||
import org.springframework.batch.item.ItemWriter;
|
||||
import org.springframework.batch.item.mail.DefaultMailErrorHandler;
|
||||
import org.springframework.batch.item.mail.MailErrorHandler;
|
||||
@@ -31,6 +25,11 @@ import org.springframework.mail.javamail.JavaMailSender;
|
||||
import org.springframework.mail.javamail.MimeMailMessage;
|
||||
import org.springframework.util.Assert;
|
||||
|
||||
import javax.mail.internet.MimeMessage;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Map.Entry;
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* A simple {@link ItemWriter} that can send mail messages. If it fails there is
|
||||
@@ -68,7 +67,7 @@ public class MimeMessageItemWriter implements ItemWriter<MimeMessage> {
|
||||
/**
|
||||
* A {@link JavaMailSender} to be used to send messages in {@link #write(List)}.
|
||||
*
|
||||
* @param mailSender
|
||||
* @param mailSender service for doing the work of sending a MIME message
|
||||
*/
|
||||
public void setJavaMailSender(JavaMailSender mailSender) {
|
||||
this.mailSender = mailSender;
|
||||
|
||||
@@ -49,17 +49,19 @@ public abstract class AbstractItemCountingItemStreamItemReader<T> extends Abstra
|
||||
* Read next item from input.
|
||||
*
|
||||
* @return item
|
||||
* @throws Exception
|
||||
* @throws Exception Allows subclasses to throw checked exceptions for interpretation by the framework
|
||||
*/
|
||||
protected abstract T doRead() throws Exception;
|
||||
|
||||
/**
|
||||
* Open resources necessary to start reading input.
|
||||
* @throws Exception Allows subclasses to throw checked exceptions for interpretation by the framework
|
||||
*/
|
||||
protected abstract void doOpen() throws Exception;
|
||||
|
||||
/**
|
||||
* Close the resources opened in {@link #doOpen()}.
|
||||
* @throws Exception Allows subclasses to throw checked exceptions for interpretation by the framework
|
||||
*/
|
||||
protected abstract void doClose() throws Exception;
|
||||
|
||||
@@ -67,6 +69,9 @@ public abstract class AbstractItemCountingItemStreamItemReader<T> extends Abstra
|
||||
* Move to the given item index. Subclasses should override this method if
|
||||
* there is a more efficient way of moving to given index than re-reading
|
||||
* the input using {@link #doRead()}.
|
||||
*
|
||||
* @param itemIndex index of item (0 based) to jump to.
|
||||
* @throws Exception Allows subclasses to throw checked exceptions for interpretation by the framework
|
||||
*/
|
||||
protected void jumpToItem(int itemIndex) throws Exception {
|
||||
for (int i = 0; i < itemIndex; i++) {
|
||||
|
||||
@@ -50,7 +50,7 @@ public interface Poller<T> {
|
||||
*
|
||||
* @param callable a {@link Callable} to use to retrieve a result
|
||||
* @return a future which itself can be used to get the result
|
||||
*
|
||||
* @throws java.lang.Exception
|
||||
*/
|
||||
Future<T> poll(Callable<T> callable) throws Exception;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user