From 9912e485ed3e87dc76e9b5d7554ec6ec3183e1a1 Mon Sep 17 00:00:00 2001 From: Yanming Zhou Date: Fri, 26 Jan 2024 10:08:14 +0800 Subject: [PATCH] Remove unnecessary javadoc from test code if method signature is self-described Closes: #3332 --- .../data/jpa/domain/sample/AuditableUser.java | 14 -- .../data/jpa/domain/sample/Child.java | 3 - .../data/jpa/domain/sample/Role.java | 24 ---- .../domain/sample/SampleWithPrimitiveId.java | 3 - .../data/jpa/domain/sample/User.java | 129 +----------------- .../jpa/domain/sample/UserSpecifications.java | 18 --- .../data/jpa/domain/sample/VersionedUser.java | 12 -- ...aQueryRewriterWithCdiIntegrationTests.java | 5 +- .../custom/CustomGenericJpaRepository.java | 6 - .../CustomGenericJpaRepositoryFactory.java | 4 - .../custom/CustomGenericRepository.java | 6 - .../repository/query/EqlComplianceTests.java | 2 - .../query/EqlQueryRendererTests.java | 2 - .../query/HqlQueryRendererTests.java | 2 - .../jpa/repository/query/Jpa21UtilsTests.java | 12 -- .../JpaQueryRewriteIntegrationTests.java | 3 - .../query/JpqlQueryRendererTests.java | 2 - .../sample/AuditableUserRepository.java | 6 - ...edeclaringRepositoryMethodsRepository.java | 3 - .../jpa/repository/sample/UserRepository.java | 40 +----- .../sample/UserRepositoryCustom.java | 2 - .../data/jpa/util/HidingClassLoader.java | 12 -- 22 files changed, 7 insertions(+), 303 deletions(-) diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/AuditableUser.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/AuditableUser.java index c7d787275..794b2cd89 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/AuditableUser.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/AuditableUser.java @@ -57,33 +57,19 @@ public class AuditableUser extends AbstractAuditable { this.firstname = firstname; } - /** - * Returns the firstname. - * - * @return the firstname - */ public String getFirstname() { - return firstname; } - /** - * Sets the firstname. - * - * @param firstname the firstname to set - */ public void setFirstname(final String firstname) { - this.firstname = firstname; } public void addRole(AuditableRole role) { - this.roles.add(role); } public Set getRoles() { - return roles; } } diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Child.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Child.java index ea911192b..05673e35b 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Child.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Child.java @@ -33,9 +33,6 @@ public class Child { @ManyToMany(mappedBy = "children") Set parents = new HashSet<>(); - /** - * @param parent - */ public Child add(Parent parent) { this.parents.add(parent); diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Role.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Role.java index 9c3556cd0..f9518a8fb 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Role.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Role.java @@ -33,50 +33,26 @@ public class Role { @Id @GeneratedValue private Integer id; private String name; - /** - * Creates a new instance of {@code Role}. - */ public Role() {} - /** - * Creates a new preconfigured {@code Role}. - * - * @param name - */ public Role(final String name) { this.name = name; } - /** - * Returns the id. - * - * @return - */ public Integer getId() { - return id; } - /** - * @return the name - */ public String getName() { return name; } @Override public String toString() { - return PREFIX + name; } - /** - * Returns whether the role is to be considered new. - * - * @return - */ public boolean isNew() { - return id == null; } } diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/SampleWithPrimitiveId.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/SampleWithPrimitiveId.java index d6280c006..a84c1409f 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/SampleWithPrimitiveId.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/SampleWithPrimitiveId.java @@ -26,9 +26,6 @@ public class SampleWithPrimitiveId { @Id private long id; - /** - * @param id the id to set - */ public void setId(long id) { this.id = id; } diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/User.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/User.java index aa4ba7329..83fce267e 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/User.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/User.java @@ -115,21 +115,10 @@ public class User { @Temporal(TemporalType.DATE) private Date dateOfBirth; - /** - * Creates a new empty instance of {@code User}. - */ public User() { this(null, null, null); } - /** - * Creates a new instance of {@code User} with preinitialized values for firstname, lastname, email address and roles. - * - * @param firstname - * @param lastname - * @param emailAddress - * @param roles - */ public User(String firstname, String lastname, String emailAddress, Role... roles) { this.firstname = firstname; @@ -142,222 +131,119 @@ public class User { this.createdAt = new Date(); } - /** - * @return the id - */ public Integer getId() { - return id; } - /** - * @param id the id to set - */ public void setId(Integer id) { - this.id = id; } - /** - * Returns the firstname. - * - * @return the firstname - */ public String getFirstname() { - return firstname; } - /** - * Sets the firstname. - * - * @param firstname the firstname to set - */ public void setFirstname(final String firstname) { - this.firstname = firstname; } - /** - * Returns the lastname. - * - * @return the lastname - */ public String getLastname() { - return lastname; } - /** - * Sets the lastname. - * - * @param lastname the lastname to set - */ public void setLastname(String lastname) { - this.lastname = lastname; } - /** - * @return the age - */ public int getAge() { return age; } - /** - * @param age the age to set - */ public void setAge(int age) { this.age = age; } - /** - * Returns the email address. - * - * @return the emailAddress - */ public String getEmailAddress() { return emailAddress; } - /** - * Sets the email address. - * - * @param emailAddress the emailAddress to set - */ public void setEmailAddress(String emailAddress) { this.emailAddress = emailAddress; } - /** - * @param active the active to set - */ public void setActive(boolean active) { this.active = active; } - /** - * @return the active - */ public boolean isActive() { return active; } - /** - * Returns the user's roles. - * - * @return the roles - */ public Set getRoles() { return roles; } - /** - * Gives the user a role. Adding a role the user already owns is a no-op. - */ public void addRole(Role role) { roles.add(role); } - /** - * Revokes a role from a user. - * - * @param role - */ public void removeRole(Role role) { roles.remove(role); } - /** - * Returns the colleagues of the user. - * - * @return the colleagues - */ public Set getColleagues() { return colleagues; } - /** - * Adds a new colleague to the user. Adding the user himself as colleague is a no-op. - * - * @param collegue - */ - public void addColleague(User collegue) { + public void addColleague(User colleague) { // Prevent from adding the user himself as colleague. - if (this.equals(collegue)) { + if (this.equals(colleague)) { return; } - colleagues.add(collegue); - collegue.getColleagues().add(this); + colleagues.add(colleague); + colleague.getColleagues().add(this); } - /** - * Removes a colleague from the list of colleagues. - * - * @param colleague - */ public void removeColleague(User colleague) { colleagues.remove(colleague); colleague.getColleagues().remove(this); } - /** - * @return the manager - */ public User getManager() { return manager; } - /** - * @param manager the manager to set - */ public void setManager(User manager) { this.manager = manager; } - /** - * @return the createdAt - */ public Date getCreatedAt() { return createdAt; } - /** - * @return the address - */ public Address getAddress() { return address; } - /** - * @param address the address to set - */ public void setAddress(Address address) { this.address = address; } - /** - * @param binaryData the binaryData to set - */ public void setBinaryData(byte[] binaryData) { this.binaryData = binaryData; } - /** - * @return the binaryData - */ public byte[] getBinaryData() { return binaryData; } @@ -378,16 +264,10 @@ public class User { return this.getId().equals(that.getId()); } - /** - * @return the attributes - */ public Set getAttributes() { return attributes; } - /** - * @param attributes the attributes to set - */ public void setAttributes(Set attributes) { this.attributes = attributes; } @@ -406,7 +286,6 @@ public class User { @Override public String toString() { - return "User: " + getId() + ", " + getFirstname() + " " + getLastname() + ", " + getEmailAddress(); } } diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/UserSpecifications.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/UserSpecifications.java index 3ac63c190..287cbe1e7 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/UserSpecifications.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/UserSpecifications.java @@ -30,44 +30,26 @@ import org.springframework.data.jpa.domain.Specification; */ public class UserSpecifications { - /** - * A {@link Specification} to match on a {@link User}'s firstname. - */ public static Specification userHasFirstname(final String firstname) { return simplePropertySpec("firstname", firstname); } - /** - * A {@link Specification} to match on a {@link User}'s lastname. - */ public static Specification userHasLastname(final String lastname) { return simplePropertySpec("lastname", lastname); } - /** - * A {@link Specification} to do a like-match on a {@link User}'s firstname. - */ public static Specification userHasFirstnameLike(final String expression) { return (root, query, cb) -> cb.like(root.get("firstname").as(String.class), String.format("%%%s%%", expression)); } - /** - * A {@link Specification} to do an age check. - * - * @param age upper (exclusive) bound of the age - */ public static Specification userHasAgeLess(final Integer age) { return (root, query, cb) -> cb.lessThan(root.get("age").as(Integer.class), age); } - /** - * A {@link Specification} to do a like-match on a {@link User}'s lastname but also adding a sort order on the - * firstname. - */ public static Specification userHasLastnameLikeWithSort(final String expression) { return (root, query, cb) -> { diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/VersionedUser.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/VersionedUser.java index 3a2a58ba6..5e5927e1e 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/VersionedUser.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/VersionedUser.java @@ -33,30 +33,18 @@ public class VersionedUser { @Version private Long version; - /** - * @return the id - */ public Long getId() { return id; } - /** - * @param id the id to set - */ public void setId(Long id) { this.id = id; } - /** - * @return the version - */ public Long getVersion() { return version; } - /** - * @param version the version to set - */ public void setVersion(Long version) { this.version = version; } diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/cdi/JpaQueryRewriterWithCdiIntegrationTests.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/cdi/JpaQueryRewriterWithCdiIntegrationTests.java index 3af67645c..30d6a7b85 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/cdi/JpaQueryRewriterWithCdiIntegrationTests.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/cdi/JpaQueryRewriterWithCdiIntegrationTests.java @@ -42,7 +42,7 @@ import org.springframework.data.jpa.repository.QueryRewriter; import org.springframework.data.repository.cdi.Eager; /** - * Unit tests for repository with {@link Query} and {@link QueryRewrite} in a CDI environment. + * Unit tests for repository with {@link Query} and {@link QueryRewriter} in a CDI environment. * * @author Greg Turnquist */ @@ -216,9 +216,6 @@ class JpaQueryRewriterWithCdiIntegrationTests { /** * One query rewriter function to rule them all! - * - * @param query - * @param sort */ private static String replaceAlias(String query, Sort sort) { diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/custom/CustomGenericJpaRepository.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/custom/CustomGenericJpaRepository.java index b2e0df001..e9c53f287 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/custom/CustomGenericJpaRepository.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/custom/CustomGenericJpaRepository.java @@ -30,18 +30,12 @@ import org.springframework.data.jpa.repository.support.SimpleJpaRepository; public class CustomGenericJpaRepository extends SimpleJpaRepository implements CustomGenericRepository { - /** - * @param metadata - * @param entityManager - */ public CustomGenericJpaRepository(JpaEntityInformation metadata, EntityManager entityManager) { - super(metadata, entityManager); } @Override public T customMethod(ID id) { - throw new UnsupportedOperationException("Forced exception for testing purposes."); } } diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/custom/CustomGenericJpaRepositoryFactory.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/custom/CustomGenericJpaRepositoryFactory.java index 9dfa2af2d..ab6b76002 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/custom/CustomGenericJpaRepositoryFactory.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/custom/CustomGenericJpaRepositoryFactory.java @@ -34,11 +34,7 @@ import org.springframework.data.repository.core.RepositoryMetadata; */ public class CustomGenericJpaRepositoryFactory extends JpaRepositoryFactory { - /** - * @param entityManager - */ public CustomGenericJpaRepositoryFactory(EntityManager entityManager) { - super(entityManager); } diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/custom/CustomGenericRepository.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/custom/CustomGenericRepository.java index 0fc9dca82..b39c31c29 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/custom/CustomGenericRepository.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/custom/CustomGenericRepository.java @@ -31,11 +31,5 @@ import org.springframework.data.repository.CrudRepository; @NoRepositoryBean public interface CustomGenericRepository extends JpaRepository { - /** - * Custom sample method. - * - * @param id - * @return - */ T customMethod(ID id); } diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/EqlComplianceTests.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/EqlComplianceTests.java index 67cbf2237..86046779e 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/EqlComplianceTests.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/EqlComplianceTests.java @@ -37,8 +37,6 @@ class EqlComplianceTests { /** * Parse the query using {@link EqlParser} then run it through the query-preserving {@link EqlQueryRenderer}. - * - * @param query */ private static String parseWithoutChanges(String query) { diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/EqlQueryRendererTests.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/EqlQueryRendererTests.java index b8a6030e2..323e29c92 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/EqlQueryRendererTests.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/EqlQueryRendererTests.java @@ -37,8 +37,6 @@ class EqlQueryRendererTests { /** * Parse the query using {@link EqlParser} then run it through the query-preserving {@link EqlQueryRenderer}. - * - * @param query */ private static String parseWithoutChanges(String query) { diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/HqlQueryRendererTests.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/HqlQueryRendererTests.java index 117e0e6cc..2f547b718 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/HqlQueryRendererTests.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/HqlQueryRendererTests.java @@ -39,8 +39,6 @@ class HqlQueryRendererTests { /** * Parse the query using {@link HqlParser} then run it through the query-preserving {@link HqlQueryRenderer}. - * - * @param query */ private static String parseWithoutChanges(String query) { diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/Jpa21UtilsTests.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/Jpa21UtilsTests.java index 5fd18dc08..f09d50be0 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/Jpa21UtilsTests.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/Jpa21UtilsTests.java @@ -168,10 +168,6 @@ class Jpa21UtilsTests { /** * Lookup the {@link AttributeNode} with given {@literal nodeName} in the root of the given {@literal graph}. - * - * @param nodeName - * @param graph - * @return */ static @Nullable AttributeNode findNode(String nodeName, @Nullable EntityGraph graph) { @@ -184,10 +180,6 @@ class Jpa21UtilsTests { /** * Lookup the {@link AttributeNode} with given {@literal nodeName} in the {@link List} of given {@literal nodes}. - * - * @param nodeName - * @param nodes - * @return */ @Nullable static AttributeNode findNode(String nodeName, List> nodes) { @@ -208,10 +200,6 @@ class Jpa21UtilsTests { /** * Lookup the {@link AttributeNode} with given {@literal nodeName} in the first {@link Subgraph} of the given * {@literal node}. - * - * @param attributeName - * @param node - * @return */ @Nullable static AttributeNode findNode(String attributeName, AttributeNode node) { diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/JpaQueryRewriteIntegrationTests.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/JpaQueryRewriteIntegrationTests.java index 5e503ef86..4c504e8cc 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/JpaQueryRewriteIntegrationTests.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/JpaQueryRewriteIntegrationTests.java @@ -205,9 +205,6 @@ class JpaQueryRewriteIntegrationTests { /** * One query rewriter function to rule them all! - * - * @param query - * @param sort */ private static String replaceAlias(String query, Sort sort) { diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/JpqlQueryRendererTests.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/JpqlQueryRendererTests.java index 141fde4f3..746657be8 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/JpqlQueryRendererTests.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/JpqlQueryRendererTests.java @@ -38,8 +38,6 @@ class JpqlQueryRendererTests { /** * Parse the query using {@link HqlParser} then run it through the query-preserving {@link HqlQueryRenderer}. - * - * @param query */ private static String parseWithoutChanges(String query) { diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/AuditableUserRepository.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/AuditableUserRepository.java index e835928ad..127c237fb 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/AuditableUserRepository.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/AuditableUserRepository.java @@ -30,12 +30,6 @@ import org.springframework.data.jpa.repository.Query; */ public interface AuditableUserRepository extends JpaRepository { - /** - * Returns all users with the given firstname. - * - * @param firstname - * @return all users with the given firstname. - */ List findByFirstname(final String firstname); @Modifying diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/RedeclaringRepositoryMethodsRepository.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/RedeclaringRepositoryMethodsRepository.java index f5cb75953..dd9343fff 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/RedeclaringRepositoryMethodsRepository.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/RedeclaringRepositoryMethodsRepository.java @@ -40,9 +40,6 @@ public interface RedeclaringRepositoryMethodsRepository extends CrudRepository findAll(Pageable page); diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/UserRepository.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/UserRepository.java index ab0e8221d..59b9965c2 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/UserRepository.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/UserRepository.java @@ -69,22 +69,19 @@ public interface UserRepository extends JpaRepository, JpaSpecifi /** * Retrieve users by their lastname. The finder {@literal User.findByLastname} is declared in * {@literal META-INF/orm.xml} . - * - * @param lastname - * @return all users with the given lastname */ @QueryHints({ @QueryHint(name = "foo", value = "bar") }) List findByLastname(String lastname); /** - * Redeclaration of {@link CrudRepository#findById(java.io.Serializable)} to change transaction configuration. + * Redeclaration of {@link CrudRepository#findById(java.lang.Object)} to change transaction configuration. */ @Transactional @Override java.util.Optional findById(Integer primaryKey); /** - * Redeclaration of {@link CrudRepository#deleteById(java.io.Serializable)}. to make sure the transaction + * Redeclaration of {@link CrudRepository#deleteById(java.lang.Object)}. to make sure the transaction * configuration of the original method is considered if the redeclaration does not carry a {@link Transactional} * annotation. */ @@ -94,9 +91,6 @@ public interface UserRepository extends JpaRepository, JpaSpecifi /** * Retrieve users by their email address. The finder {@literal User.findByEmailAddress} is declared as annotation at * {@code User}. - * - * @param emailAddress - * @return the user with the given email address */ User findByEmailAddress(String emailAddress); @@ -105,29 +99,17 @@ public interface UserRepository extends JpaRepository, JpaSpecifi /** * Retrieves users by the given email and lastname. Acts as a dummy method declaration to test finder query creation. - * - * @param emailAddress - * @param lastname - * @return the user with the given email address and lastname */ User findByEmailAddressAndLastname(String emailAddress, String lastname); /** * Retrieves users by email address and lastname or firstname. Acts as a dummy method declaration to test finder query * creation. - * - * @param emailAddress - * @param lastname - * @param username - * @return the users with the given email address and lastname or the given firstname */ List findByEmailAddressAndLastnameOrFirstname(String emailAddress, String lastname, String username); /** * Retrieves a user by its username using the query annotated to the method. - * - * @param emailAddress - * @return */ @Query("select u from User u where u.emailAddress = ?1") @Transactional(readOnly = true) @@ -135,20 +117,12 @@ public interface UserRepository extends JpaRepository, JpaSpecifi /** * Method to directly create query from and adding a {@link Pageable} parameter to be regarded on query execution. - * - * @param pageable - * @param lastname - * @return */ Page findByLastname(Pageable pageable, String lastname); /** * Method to directly create query from and adding a {@link Pageable} parameter to be regarded on query execution. * Just returns the queried {@link Page}'s contents. - * - * @param firstname - * @param pageable - * @return */ List findByFirstname(String firstname, Pageable pageable); @@ -175,8 +149,6 @@ public interface UserRepository extends JpaRepository, JpaSpecifi /** * Manipulating query to set all {@link User}'s names to the given one. - * - * @param lastname */ @Modifying @Query("update User u set u.lastname = ?1") @@ -187,10 +159,6 @@ public interface UserRepository extends JpaRepository, JpaSpecifi /** * Method where parameters will be applied by name. Note that the order of the parameters is then not crucial anymore. - * - * @param foo - * @param bar - * @return */ @Query("select u from User u where u.lastname = :lastname or u.firstname = :firstname") List findByLastnameOrFirstname(@Param("firstname") String foo, @Param("lastname") String bar); @@ -200,10 +168,6 @@ public interface UserRepository extends JpaRepository, JpaSpecifi /** * Method to check query creation and named parameter usage go well hand in hand. - * - * @param lastname - * @param firstname - * @return */ List findByFirstnameOrLastname(@Param("lastname") String lastname, @Param("firstname") String firstname); diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/UserRepositoryCustom.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/UserRepositoryCustom.java index 130e83e7d..485f71b8d 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/UserRepositoryCustom.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/UserRepositoryCustom.java @@ -31,8 +31,6 @@ public interface UserRepositoryCustom { /** * Some custom method to implement. - * - * @param user */ void someCustomMethod(User user); } diff --git a/spring-data-jpa/src/test/java/org/springframework/data/jpa/util/HidingClassLoader.java b/spring-data-jpa/src/test/java/org/springframework/data/jpa/util/HidingClassLoader.java index f996d2a69..ce60e381e 100644 --- a/spring-data-jpa/src/test/java/org/springframework/data/jpa/util/HidingClassLoader.java +++ b/spring-data-jpa/src/test/java/org/springframework/data/jpa/util/HidingClassLoader.java @@ -47,12 +47,6 @@ public class HidingClassLoader extends ShadowingClassLoader { this.hidden = hidden; } - /** - * Creates a new {@link HidingClassLoader} with the packages of the given classes hidden. - * - * @param packages must not be {@literal null}. - * @return - */ public static HidingClassLoader hide(Class... packages) { Assert.notNull(packages, "Packages must not be null"); @@ -62,12 +56,6 @@ public class HidingClassLoader extends ShadowingClassLoader { .collect(Collectors.toList())); } - /** - * Creates a new {@link HidingClassLoader} with the packages of the given classes hidden. - * - * @param packages must not be {@literal null}. - * @return - */ public static HidingClassLoader hidePackages(String... packages) { Assert.notNull(packages, "Packages must not be null");