This commit is contained in:
Michael Minella
2017-09-11 22:33:10 -05:00
parent 9fc6ba149b
commit 63df1fe529
17 changed files with 88 additions and 94 deletions

View File

@@ -58,7 +58,8 @@ public class ExecutionContext implements Serializable {
}
/**
* Initializes a new execution context with the contents of another executionContext.
* Initializes a new {@link ExecutionContext} with the contents of another
* {@code ExecutionContext}.
*
* @param executionContext containing the entries to be copied to this current context.
*/

View File

@@ -70,7 +70,7 @@ public abstract class KeyValueItemWriter<K, V> implements ItemWriter<V>, Initial
* Sets the delete flag to have the item writer perform deletes
*
* @param delete if true {@link ItemWriter} will perform deletes,
* if False not to perform deletes.
* if false not to perform deletes.
*/
public void setDelete(boolean delete) {
this.delete = delete;

View File

@@ -53,7 +53,7 @@ public abstract class AbstractMethodInvokingDelegator<T> implements Initializing
*
* @return object returned by invoked method
*
* @throws Exception if the {@link MethodInvoker} used, throws an Exception.
* @throws Exception exception thrown when executing the delegate method.
*/
protected T invokeDelegateMethod() throws Exception {
MethodInvoker invoker = createMethodInvoker(targetObject, targetMethod);
@@ -67,7 +67,7 @@ public abstract class AbstractMethodInvokingDelegator<T> implements Initializing
* @param object argument for the target method
* @return object returned by target method
*
* @throws Exception if the {@link MethodInvoker} used throws exception
* @throws Exception exception thrown when executing the delegate method.
*/
protected T invokeDelegateMethodWithArgument(Object object) throws Exception {
MethodInvoker invoker = createMethodInvoker(targetObject, targetMethod);
@@ -81,7 +81,7 @@ public abstract class AbstractMethodInvokingDelegator<T> implements Initializing
* @param args arguments for the invoked method
* @return object returned by invoked method
*
* @throws Exception if the {@link MethodInvoker} used, throws an exception
* @throws Exception exception thrown when executing the delegate method.
*/
protected T invokeDelegateMethodWithArguments(Object[] args) throws Exception {
MethodInvoker invoker = createMethodInvoker(targetObject, targetMethod);

View File

@@ -42,7 +42,7 @@ public interface JpaQueryProvider {
/**
* Provide an {@link EntityManager} for the query to be built.
*
* @param entityManager to be used by the JpQueryProvider.
* @param entityManager to be used by the {@link JpaQueryProvider}.
*/
void setEntityManager(EntityManager entityManager);

View File

@@ -221,8 +221,7 @@ InitializingBean {
* headerCallback will be called before writing the first item to file.
* Newline will be automatically appended after the header is written.
*
* @param headerCallback {@link FlatFileHeaderCallback} to be used after
* header is written.
* @param headerCallback {@link FlatFileHeaderCallback} to generate the header
*
*/
public void setHeaderCallback(FlatFileHeaderCallback headerCallback) {
@@ -233,8 +232,7 @@ InitializingBean {
* footerCallback will be called after writing the last item to file, but
* before the file is closed.
*
* @param footerCallback {@link FlatFileFooterCallback} to be used after
* footer is written.
* @param footerCallback {@link FlatFileFooterCallback} to generate the footer
*
*/
public void setFooterCallback(FlatFileFooterCallback footerCallback) {

View File

@@ -102,8 +102,8 @@ public class MultiResourceItemWriter<T> extends AbstractItemStreamItemWriter<T>
* After this limit is exceeded the next chunk will be written into newly
* created resource.
*
* @param itemCountLimitPerResource int containing the limit to determine
* when the next chunk will be written to a newly created resource.
* @param itemCountLimitPerResource int item threshold used to determine when a new
* resource should be created.
*/
public void setItemCountLimitPerResource(int itemCountLimitPerResource) {
this.itemCountLimitPerResource = itemCountLimitPerResource;
@@ -133,8 +133,7 @@ public class MultiResourceItemWriter<T> extends AbstractItemStreamItemWriter<T>
/**
* Establishes that state of each resource is saved to the context when
* update is called.
* Indicates that the state of the reader will be saved after each commit.
*
* @param saveState true the state is saved.
*/

View File

@@ -44,7 +44,7 @@ public class SimpleBinaryBufferedReaderFactory implements BufferedReaderFactory
private String lineEnding = DEFAULT_LINE_ENDING;
/**
* @param lineEnding {@link String} contains the line ending to use.
* @param lineEnding {@link String} indicating what defines the end of a "line".
*/
public void setLineEnding(String lineEnding) {
this.lineEnding = lineEnding;

View File

@@ -667,7 +667,7 @@ public class DefaultFieldSet implements FieldSet {
/**
* Retrieve the index of where a specified column is located based on the
* name parameter.
* {@code name} parameter.
*
* @param name the value to search in the {@link List} of names.
* @return the index in the {@link List} of names where the name was found.

View File

@@ -1,4 +1,4 @@
/*
/*
* Copyright 2006-2007 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -59,15 +59,15 @@ public interface FieldSet {
* @param index the field index.
* @return {@link String} containing the value at the index.
*
* @throws IndexOutOfBoundsException if the index is out of bounds.
* @throws IndexOutOfBoundsException if the {@code index} is out of bounds.
*/
String readString(int index);
/**
* Read the {@link String} value from column with given '<code>name</code>'.
*
* @param name the field name.
* @return {@link String} containing the value from the specified name.
* @param name the field {@code name}.
* @return {@link String} containing the value from the specified {@code name}.
*/
String readString(String name);
@@ -76,9 +76,9 @@ public interface FieldSet {
* trailing whitespace (don't trim).
*
* @param index the field index.
* @return {@link String} containing the value from the specified index.
* @return {@link String} containing the value from the specified {@code index}.
*
* @throws IndexOutOfBoundsException if the index is out of bounds.
* @throws IndexOutOfBoundsException if the {@code index} is out of bounds.
*/
String readRawString(int index);
@@ -86,8 +86,8 @@ public interface FieldSet {
* Read the {@link String} value from column with given '<code>name</code>'
* including trailing whitespace (don't trim).
*
* @param name the field name.
* @return {@link String} containing the value from the specified name.
* @param name the field {@code name}.
* @return {@link String} containing the value from the specified {@code name}.
*/
String readRawString(String name);
@@ -95,19 +95,19 @@ public interface FieldSet {
* Read the '<code>boolean</code>' value at index '<code>index</code>'.
*
* @param index the field index.
* @return boolean containing the value from the specified index.
* @return boolean containing the value from the specified {@code index}.
*
* @throws IndexOutOfBoundsException if the index is out of bounds.
* @throws IndexOutOfBoundsException if the {@code index} is out of bounds.
*/
boolean readBoolean(int index);
/**
* Read the '<code>boolean</code>' value from column with given '<code>name</code>'.
*
* @param name the field name.
* @return boolean containing the value from the specified name.
* @param name the field {@code name}.
* @return boolean containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined.
*/
boolean readBoolean(String name);
@@ -118,7 +118,7 @@ public interface FieldSet {
* @param index the field index.
* @param trueValue the value that signifies {@link Boolean#TRUE true};
* case-sensitive.
* @return boolean containing the value from the specified index.
* @return boolean containing the value from the specified {@code index}.
*
* @throws IndexOutOfBoundsException if the index is out of bounds, or if
* the supplied <code>trueValue</code> is <code>null</code>.
@@ -128,12 +128,12 @@ public interface FieldSet {
/**
* Read the '<code>boolean</code>' value from column with given '<code>name</code>'.
*
* @param name the field name.
* @param name the field {@code name}.
* @param trueValue the value that signifies {@link Boolean#TRUE true};
* case-sensitive.
* @return boolean containing the value from the specified name.
* @return boolean containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined, or if the supplied <code>trueValue</code> is <code>null</code>.
*/
boolean readBoolean(String name, String trueValue);
@@ -142,7 +142,7 @@ public interface FieldSet {
* Read the '<code>char</code>' value at index '<code>index</code>'.
*
* @param index the field index.
* @return char containing the value from the specified index.
* @return char containing the value from the specified {@code index}.
*
* @throws IndexOutOfBoundsException if the index is out of bounds.
*/
@@ -151,10 +151,10 @@ public interface FieldSet {
/**
* Read the '<code>char</code>' value from column with given '<code>name</code>'.
*
* @param name the field name.
* @return char containing the value from the specified name.
* @param name the field {@code name}.
* @return char containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined.
*/
char readChar(String name);
@@ -163,7 +163,7 @@ public interface FieldSet {
* Read the '<code>byte</code>' value at index '<code>index</code>'.
*
* @param index the field index.
* @return byte containing the value from the specified index.
* @return byte containing the value from the specified {@code index}.
*
* @throws IndexOutOfBoundsException if the index is out of bounds.
*/
@@ -172,15 +172,15 @@ public interface FieldSet {
/**
* Read the '<code>byte</code>' value from column with given '<code>name</code>'.
*
* @param name the field name.*
* @return byte containing the value from the specified name.
* @param name the field {@code name}.
* @return byte containing the value from the specified {@code name}.
*/
byte readByte(String name);
/**
* Read the '<code>short</code>' value at index '<code>index</code>'.
*
* @param index the field index.
* @param index the field {@code index}.
* @return short containing the value from the specified index.
*
* @throws IndexOutOfBoundsException if the index is out of bounds.
@@ -190,10 +190,10 @@ public interface FieldSet {
/**
* Read the '<code>short</code>' value from column with given '<code>name</code>'.
*
* @param name the field name.
* @return short containing the value from the specified name.
* @param name the field {@code name}.
* @return short containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined.
*/
short readShort(String name);
@@ -211,10 +211,10 @@ public interface FieldSet {
/**
* Read the '<code>int</code>' value from column with given '<code>name</code>'.
*
* @param name the field name.
* @return int containing the value from the specified name.
* @param name the field {@code name}.
* @return int containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined.
*/
int readInt(String name);
@@ -237,11 +237,11 @@ public interface FieldSet {
* using the supplied <code>defaultValue</code> if the field value is
* blank.
*
* @param name the field name.
* @param name the field {@code name}.
* @param defaultValue the value to use if the field value is blank.
* @return int containing the value from the specified name.
* @return int containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined.
*/
int readInt(String name, int defaultValue);
@@ -259,10 +259,10 @@ public interface FieldSet {
/**
* Read the '<code>long</code>' value from column with given '<code>name</code>'.
*
* @param name the field name.
* @return long containing the value from the specified name.
* @param name the field {@code name}.
* @return long containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined.
*/
long readLong(String name);
@@ -285,11 +285,11 @@ public interface FieldSet {
* using the supplied <code>defaultValue</code> if the field value is
* blank.
*
* @param name the field name.
* @param name the field {@code name}.
* @param defaultValue the value to use if the field value is blank.
* @return long containing the value from the specified name.
* @return long containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined.
*/
long readLong(String name, long defaultValue);
@@ -307,10 +307,10 @@ public interface FieldSet {
/**
* Read the '<code>float</code>' value from column with given '<code>name</code>.
*
* @param name the field name.
* @return float containing the value from the specified name.
* @param name the field {@code name}.
* @return float containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined.
*/
float readFloat(String name);
@@ -328,10 +328,10 @@ public interface FieldSet {
/**
* Read the '<code>double</code>' value from column with given '<code>name</code>.
*
* @param name the field name.
* @return double containing the value from the specified name.
* @param name the field {@code name}.
* @return double containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined.
*/
double readDouble(String name);
@@ -349,10 +349,10 @@ public interface FieldSet {
/**
* Read the {@link java.math.BigDecimal} value from column with given '<code>name</code>.
*
* @param name the field name.
* @return {@link BigDecimal} containing the value from the specified name.
* @param name the field {@code name}.
* @return {@link BigDecimal} containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined.
*/
BigDecimal readBigDecimal(String name);
@@ -375,11 +375,11 @@ public interface FieldSet {
* returning the supplied <code>defaultValue</code> if the trimmed string
* value at index '<code>index</code>' is blank.
*
* @param name the field name.
* @param name the field {@code name}.
* @param defaultValue the default value to use if the field is blank
* @return {@link BigDecimal} containing the value from the specified name.
* @return {@link BigDecimal} containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined.
*/
BigDecimal readBigDecimal(String name, BigDecimal defaultValue);
@@ -401,10 +401,10 @@ public interface FieldSet {
* Read the <code>java.sql.Date</code> value in given format from column
* with given <code>name</code>.
*
* @param name the field name.
* @return {@link Date} containing the value from the specified name.
* @param name the field {@code name}.
* @return {@link Date} containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined or if the value is not parseable
* @throws NullPointerException if the value is empty
*/
@@ -428,11 +428,11 @@ public interface FieldSet {
* Read the <code>java.sql.Date</code> value in given format from column
* with given <code>name</code>.
*
* @param name the field name.
* @param name the field {@code name}.
* @param defaultValue the default value to use if the field is blank
* @return {@link Date} containing the value from the specified name.
* @return {@link Date} containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined.
*/
Date readDate(String name, Date defaultValue);
@@ -455,11 +455,11 @@ public interface FieldSet {
* Read the <code>java.sql.Date</code> value in given format from column
* with given <code>name</code>.
*
* @param name the field name.
* @param name the field {@code name}.
* @param pattern the pattern describing the date and time format
* @return {@link Date} containing the value from the specified name.
* @return {@link Date} containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined or if the specified field cannot be parsed
*
*/
@@ -484,12 +484,12 @@ public interface FieldSet {
* Read the <code>java.sql.Date</code> value in given format from column
* with given <code>name</code>.
*
* @param name the field name.
* @param name the field {@code name}.
* @param pattern the pattern describing the date and time format
* @param defaultValue the default value to use if the field is blank
* @return {@link Date} containing the value from the specified name.
* @return {@link Date} containing the value from the specified {@code name}.
*
* @throws IllegalArgumentException if a column with given name is not
* @throws IllegalArgumentException if a column with given {@code name} is not
* defined or if the specified field cannot be parsed
*
*/

View File

@@ -34,7 +34,7 @@ public class CompositeItemStream implements ItemStream {
private List<ItemStream> streams = new ArrayList<ItemStream>();
/**
* Public setter for the streams.
* Public setter for the {@link ItemStream}s.
*
* @param streams array of {@link ItemStream}.
*/

View File

@@ -43,11 +43,6 @@ public final class FileUtils {
* @param append true signals input file may already exist (but doesn't have to)
* @param overwriteOutputFile If set to true, output file will be overwritten (this flag is ignored when processing
* is restart)
*
* @throws IllegalArgumentException when file is null
* @throws ItemStreamException when starting output file processing, file exists and flag "overwriteOutputFile" is
* set to false
* @throws ItemStreamException when unable to create file or file is not writable
*/
public static void setUpOutputFile(File file, boolean restarted, boolean append, boolean overwriteOutputFile) {

View File

@@ -62,8 +62,9 @@ public class ValidatingItemProcessor<T> implements ItemProcessor<T, T>, Initiali
/**
* Should the processor filter invalid records instead of skipping them?
*
* @param filter true if filter is to return null or false if filter is to
* throw a {@link ValidationException}.
* @param filter if set to {@code true}, items that fail validation are filtered
* ({@code null} is returned). Otherwise, a {@link ValidationException} will be
* thrown.
*/
public void setFilter(boolean filter) {
this.filter = filter;

View File

@@ -40,7 +40,7 @@ public class CompositeCompletionPolicy implements CompletionPolicy {
* Setter for the policies.
*
* @param policies an array of completion policies to be used to determine
* isComplete by consensus.
* {@link #isComplete(RepeatContext)} by consensus.
*/
public void setPolicies(CompletionPolicy[] policies) {
this.policies = Arrays.asList(policies).toArray(new CompletionPolicy[policies.length]);

View File

@@ -52,7 +52,7 @@ public class TimeoutTerminationPolicy extends CompletionPolicySupport {
* Construct a {@link TimeoutTerminationPolicy} with the specified timeout
* value (in milliseconds).
*
* @param timeout the milliseconds to be used for the timeout.
* @param timeout durration of the timeout.
*/
public TimeoutTerminationPolicy(long timeout) {
super();

View File

@@ -467,7 +467,7 @@ public class RepeatTemplate implements RepeatOperations {
/**
* Delegate to the {@link CompletionPolicy}.
*
* @return a RepeatContext object that can be used by the implementation to store
* @return a {@link RepeatContext} object that can be used by the implementation to store
* internal state for a batch step.
*
* @see org.springframework.batch.repeat.CompletionPolicy#start(RepeatContext)

View File

@@ -29,7 +29,7 @@ import org.springframework.util.ObjectUtils;
import org.springframework.util.ReflectionUtils;
/**
* MethodResolver implementation that finds a <em>single</em> Method on the
* {@link MethodResolver} implementation that finds a <em>single</em> Method on the
* given Class that contains the specified annotation type.
*
* @author Mark Fisher
@@ -40,7 +40,7 @@ public class AnnotationMethodResolver implements MethodResolver {
/**
* Create a MethodResolver for the specified Method-level annotation type.
* Create a {@link MethodResolver} for the specified Method-level annotation type.
*
* @param annotationType establish the annotation to be used.
*/

View File

@@ -185,7 +185,7 @@ public class MethodInvokerUtils {
* @param target an object to search for an appropriate method.
* @param <C> the class.
* @param <T> the type.
* @return a MethodInvoker that calls a method on the delegate.
* @return a {@link MethodInvoker} that calls a method on the delegate.
*/
public static <C, T> MethodInvoker getMethodInvokerForSingleArgument(Object target) {
final AtomicReference<Method> methodHolder = new AtomicReference<>();