Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Javadoc for thread safety [BATCH-1807] #1782

Open
spring-issuemaster opened this issue Nov 8, 2011 · 0 comments
Open

Javadoc for thread safety [BATCH-1807] #1782

spring-issuemaster opened this issue Nov 8, 2011 · 0 comments

Comments

@spring-issuemaster
Copy link
Collaborator

@spring-issuemaster spring-issuemaster commented Nov 8, 2011

Gordon Dickens opened BATCH-1807 and commented

Provide consistent text for thread safe. Javadocs have two text strings "thread safe" and "thread-safe". In addition, if a class is "not" thread safe be consistent with either "not", "NOT", or "not".


In version 2.2.0.SNAPSHOT - search results for "thread safe"

Targets
String 'thread safe'
Found usages (18 usages)
Production (18 usages)
Unclassified usage (18 usages)
spring-batch (2 usages)
/opt/springsource/spring-batch/spring-batch-samples/src/main/java/org/springframework/batch/sample/domain/multiline (2 usages)
AggregateItemReader.java (2 usages)
(35: 18) * This class is thread safe (it can be used concurrently by multiple threads)
(36: 46) * as long as the {@link ItemReader} is also thread safe.
spring-batch-core (2 usages)
org.springframework.batch.core.job.flow (1 usage)
State.java (1 usage)
(38: 16) * context is thread safe, or used in a thread safe manner.
org.springframework.batch.core.step.item (1 usage)
SimpleStepFactoryBean.java (1 usage)
(343: 16) * treated as thread safe. Clients are recommended to create a new step for
spring-batch-infrastructure (14 usages)
org.springframework.batch.item (1 usage)
ItemReader.java (1 usage)
(26: 34) * Implementations need not be thread safe and clients of a {@link ItemReader}
org.springframework.batch.item.database (4 usages)
HibernateItemWriter.java (1 usage)
(36: 18) * The writer is thread safe after its properties are set (normal singleton
IbatisBatchItemWriter.java (1 usage)
(46: 18) * The writer is thread safe after its properties are set (normal singleton
JdbcBatchItemWriter.java (1 usage)
(54: 18) * The writer is thread safe after its properties are set (normal singleton
JpaItemWriter.java (1 usage)
(43: 18) * The writer is thread safe after its properties are set (normal singleton
org.springframework.batch.item.file (1 usage)
ResourcesItemReader.java (1 usage)
(23: 4) * Thread safe between calls to {@link #open(ExecutionContext)}. The
org.springframework.batch.item.jms (2 usages)
JmsItemReader.java (1 usage)
(35: 26) * The implementation is thread safe after its properties are set (normal
JmsItemWriter.java (1 usage)
(34: 26) * The implementation is thread safe after its properties are set (normal
org.springframework.batch.item.support (1 usage)
SingleItemPeekableItemReader.java (1 usage)
(37: 22) * Intentionally not thread safe: it wouldn't be possible to honour the peek in
org.springframework.batch.item.xml (1 usage)
StaxUtils.java (1 usage)
(39: 86) * As the only class state maintained is to cache java reflection metadata, which is thread safe, this class is thread-safe.
org.springframework.batch.repeat.support (3 usages)
TaskExecutorRepeatTemplate.java (3 usages)
(37: 18) * This class is thread safe if its collaborators are thread safe (interceptors,
(41: 45) * is wrapped in the execute method must be thread safe - often it is based on
(42: 58) * some form of data source, which itself should be both thread safe and
org.springframework.batch.support (1 usage)
DefaultPropertyEditorRegistrar.java (1 usage)
(32: 11) * is not thread safe, but useful where one is confident that binding or


In version 2.2.0.SNAPSHOT - search results for "thread-safe"

Targets
String 'thread-safe'
Found usages (21 usages)
Production (21 usages)
Unclassified usage (21 usages)
spring-batch (2 usages)
/opt/springsource/spring-batch/spring-batch-samples/src/main/java/org/springframework/batch/sample/common (2 usages)
StagingItemListener.java (1 usage)
(29: 4) * Thread-safe database {@link ItemReader} implementing the process indicator
StagingItemReader.java (1 usage)
(42: 4) * Thread-safe database {@link ItemReader} implementing the process indicator
spring-batch-core (2 usages)
org.springframework.batch.core (2 usages)
ExitStatus.java (1 usage)
(28: 42) * ExitStatus is immutable and therefore thread-safe.
JobParameters.java (1 usage)
(33: 42) * This class is immutable and therefore thread-safe.
spring-batch-infrastructure (17 usages)
org.springframework.batch.item.database (5 usages)
HibernateCursorItemReader.java (1 usage)
(53: 37) * The implementation is <b>not</b> thread-safe.
HibernatePagingItemReader.java (1 usage)
(51: 26) * The implementation is thread-safe in between calls to
IbatisPagingItemReader.java (1 usage)
(64: 26) * The implementation is thread-safe in between calls to
JdbcPagingItemReader.java (1 usage)
(65: 26) * The implementation is thread-safe in between calls to
JpaPagingItemReader.java (1 usage)
(73: 26) * The implementation is thread-safe in between calls to
org.springframework.batch.item.file (1 usage)
FlatFileItemWriter.java (1 usage)
(52: 32) * The implementation is not thread-safe.
org.springframework.batch.item.support (3 usages)
AbstractItemCountingItemStreamItemReader.java (1 usage)
(33: 36) * Subclasses are inherently not thread-safe.
ClassifierCompositeItemWriter.java (1 usage)
(32: 26) * The implementation is thread-safe if all delegates are thread-safe.
CompositeItemWriter.java (1 usage)
(33: 26) * The implementation is thread-safe if all delegates are thread-safe.
org.springframework.batch.item.xml (3 usages)
StaxEventItemReader.java (1 usage)
(49: 32) * The implementation is not thread-safe.
StaxEventItemWriter.java (1 usage)
(64: 32) * The implementation is not thread-safe.
StaxUtils.java (1 usage)
(39: 113) * As the only class state maintained is to cache java reflection metadata, which is thread safe, this class is thread-safe.
org.springframework.batch.retry.backoff (4 usages)
BackOffPolicy.java (2 usages)
(24: 44) * <p/> Implementations are expected to be thread-safe and should be designed
(26: 10) * to be thread-safe but need not be suitable for high load concurrent access.
ExponentialBackOffPolicy.java (1 usage)
(27: 27) * This implementation is thread-safe and suitable for concurrent access.
FixedBackOffPolicy.java (1 usage)
(23: 44) * <p/> {@link #setBackOffPeriod(long)} is thread-safe and it is safe to call
org.springframework.batch.retry.support (1 usage)
RetryTemplate.java (1 usage)
(63: 18) * This class is thread-safe and suitable for concurrent access when executing


Affects: 2.1.8, 2.2.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.