DATACMNS-1601 - Improving the JavaDoc of the CrudRepository. #412
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -42,98 +42,112 @@ public interface RxJava2CrudRepository<T, ID> extends Repository<T, ID> { | |||||
| * entity instance completely. | ||||||
| * | ||||||
| * @param entity must not be {@literal null}. | ||||||
| * @return {@link Single} emitting the saved entity. | ||||||
| * @throws IllegalArgumentException in case the given {@code entity} is {@literal null}. | ||||||
| */ | ||||||
| <S extends T> Single<S> save(S entity); | ||||||
|
|
||||||
| /** | ||||||
| * Saves all given entities. | ||||||
| * | ||||||
| * @param entities must not be {@literal null}. | ||||||
| * @return {@link Flowable} emitting the saved entities. | ||||||
| * @throws IllegalArgumentException in case the given {@link Iterable entities} or one of its entities is | ||||||
| * {@literal null}. | ||||||
| */ | ||||||
| <S extends T> Flowable<S> saveAll(Iterable<S> entities); | ||||||
|
|
||||||
| /** | ||||||
| * Saves all given entities. | ||||||
| * | ||||||
| * @param entityStream must not be {@literal null}. | ||||||
| * @return {@link Flowable} emitting the saved entities. | ||||||
| * @throws IllegalArgumentException in case the given {@link Flowable entityStream} is {@literal null}. | ||||||
| */ | ||||||
| <S extends T> Flowable<S> saveAll(Flowable<S> entityStream); | ||||||
|
|
||||||
| /** | ||||||
| * Retrieves an entity by its id. | ||||||
| * | ||||||
| * @param id must not be {@literal null}. | ||||||
| * @return {@link Maybe} emitting the entity with the given id or {@link Maybe#empty()} if none found. | ||||||
| * @throws IllegalArgumentException in case the given {@code id} is {@literal null}. | ||||||
| */ | ||||||
| Maybe<T> findById(ID id); | ||||||
|
|
||||||
| /** | ||||||
| * Retrieves an entity by its id supplied by a {@link Single}. | ||||||
| * | ||||||
| * @param id must not be {@literal null}. Uses the first emitted element to perform the find-query. | ||||||
| * @return {@link Maybe} emitting the entity with the given id or {@link Maybe#empty()} if none found. | ||||||
| * @throws IllegalArgumentException in case the given {@link Single id} is {@literal null}. | ||||||
| */ | ||||||
| Maybe<T> findById(Single<ID> id); | ||||||
|
|
||||||
| /** | ||||||
| * Returns whether an entity with the given {@code id} exists. | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. I'm stopping commenting on this, since it is easier to find and fix within the IDE. |
||||||
| * | ||||||
| * @param id must not be {@literal null}. | ||||||
| * @return {@link Single} emitting {@literal true} if an entity with the given id exists, {@literal false} otherwise. | ||||||
|
There was a problem hiding this comment. Ok it now gets really nitpicky but shouldn't it be If you agree there are more places like this. |
||||||
| * @throws IllegalArgumentException in case the given {@code id} is {@literal null}. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| */ | ||||||
| Single<Boolean> existsById(ID id); | ||||||
|
|
||||||
| /** | ||||||
| * Returns whether an entity with the given id, supplied by a {@link Single}, exists. | ||||||
| * | ||||||
| * @param id must not be {@literal null}. | ||||||
| * @return {@link Single} emitting {@literal true} if an entity with the given id exists, {@literal false} otherwise. | ||||||
| * @throws IllegalArgumentException in case the given {@link Single id} is {@literal null}. | ||||||
|
There was a problem hiding this comment. This should be either Same in many other places. |
||||||
| */ | ||||||
| Single<Boolean> existsById(Single<ID> id); | ||||||
|
|
||||||
| /** | ||||||
| * Returns all instances of the type. | ||||||
| * | ||||||
| * @return {@link Flowable} emitting all entities. | ||||||
| */ | ||||||
| Flowable<T> findAll(); | ||||||
|
|
||||||
| /** | ||||||
| * Returns all instances of the type {@code T} with the given IDs. | ||||||
|
There was a problem hiding this comment. We are mixing IDs and ids and I think it should be {@literal ids} referring to the parameter name. |
||||||
| * <p> | ||||||
| * If some or all ids are not found, no entities are returned for these IDs. | ||||||
| * <p> | ||||||
| * Note that the order of elements in the result is not guaranteed. | ||||||
| * | ||||||
| * @param ids must not be {@literal null} nor contain any {@literal null} values. | ||||||
| * @return {@link Flowable} emitting the found entities. The size can be equal or less than the number of given | ||||||
| * {@code ids}. | ||||||
| * @throws IllegalArgumentException in case the given {@link Iterable ids} or one of its items is {@literal null}. | ||||||
| */ | ||||||
| Flowable<T> findAllById(Iterable<ID> ids); | ||||||
|
|
||||||
| /** | ||||||
| * Returns all instances of the type {@code T} with the given IDs supplied by a {@link Flowable}. | ||||||
|
|
||||||
| * <p> | ||||||
| * If some or all ids are not found, no entities are returned for these IDs. | ||||||
| * <p> | ||||||
| * Note that the order of elements in the result is not guaranteed. | ||||||
| * | ||||||
| * @param idStream must not be {@literal null}. | ||||||
| * @return {@link Flowable} emitting the found entities. | ||||||
| * @throws IllegalArgumentException in case the given {@link Flowable idStream} is {@literal null}. | ||||||
| */ | ||||||
| Flowable<T> findAllById(Flowable<ID> idStream); | ||||||
|
|
||||||
| /** | ||||||
| * Returns the number of entities available. | ||||||
| * | ||||||
| * @return {@link Single} emitting the number of entities. | ||||||
| */ | ||||||
| Single<Long> count(); | ||||||
|
|
||||||
| /** | ||||||
| * Deletes the entity with the given id. | ||||||
| * | ||||||
| * @param id must not be {@literal null}. | ||||||
| * @return {@link Completable} signaling when operation has completed. | ||||||
| * @throws IllegalArgumentException in case the given {@code id} is {@literal null}. | ||||||
| */ | ||||||
| Completable deleteById(ID id); | ||||||
|
|
@@ -142,6 +156,7 @@ public interface RxJava2CrudRepository<T, ID> extends Repository<T, ID> { | |||||
| * Deletes a given entity. | ||||||
| * | ||||||
| * @param entity must not be {@literal null}. | ||||||
| * @return {@link Completable} signaling when operation has completed. | ||||||
| * @throws IllegalArgumentException in case the given entity is {@literal null}. | ||||||
| */ | ||||||
| Completable delete(T entity); | ||||||
|
|
@@ -150,20 +165,25 @@ public interface RxJava2CrudRepository<T, ID> extends Repository<T, ID> { | |||||
| * Deletes the given entities. | ||||||
| * | ||||||
| * @param entities must not be {@literal null}. | ||||||
| * @return {@link Completable} signaling when operation has completed. | ||||||
| * @throws IllegalArgumentException in case the given {@link Iterable entities} or one of its entities is | ||||||
| * {@literal null}. | ||||||
| */ | ||||||
| Completable deleteAll(Iterable<? extends T> entities); | ||||||
|
|
||||||
| /** | ||||||
| * Deletes the given entities supplied by a {@link Flowable}. | ||||||
| * | ||||||
| * @param entityStream must not be {@literal null}. | ||||||
| * @return {@link Completable} signaling when operation has completed. | ||||||
| * @throws IllegalArgumentException in case the given {@link Flowable entityStream} is {@literal null}. | ||||||
| */ | ||||||
| Completable deleteAll(Flowable<? extends T> entityStream); | ||||||
|
|
||||||
| /** | ||||||
| * Deletes all entities managed by the repository. | ||||||
| * | ||||||
| * @return {@link Completable} signaling when operation has completed. | ||||||
| */ | ||||||
| Completable deleteAll(); | ||||||
| } | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.