Fixed checkstyle issues.

Signed-off-by: Tomáš Kraus <[email protected]>

Author: Tomáš Kraus

etc/checkstyle-suppressions.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <!--
 
-    Copyright (c) 2016, 2023 Oracle and/or its affiliates.
+    Copyright (c) 2016, 2025 Oracle and/or its affiliates.
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
@@ -43,4 +43,6 @@
               files="examples/openapi-tools/"/>
     <suppress checks="HideUtilityClassConstructor"
               files="examples/openapi-tools/"/>
+    <suppress checks="MethodName"
+              files="examples/data/"/>
 </suppressions>

examples/data/mp/src/main/java/io/helidon/examples/data/mp/service/BreedService.java

@@ -56,6 +56,8 @@ public BreedService(BreedRepository breedRepository) {
 
     /**
      * Handles the {@code GET /} request and returns the index page with endpoint information.
+     *
+     * @return the index page with endpoint information
      */
     @GET
     @Produces(MediaTypes.TEXT_PLAIN_VALUE)
@@ -70,6 +72,8 @@ public String index() {
 
     /**
      * Handles the {@code GET /all} request and returns a list of all {@link Breed} entities.
+     *
+     * @return the list of all {@link Breed} entities
      */
     @GET
     @Path("/all")
@@ -83,6 +87,7 @@ public List<Breed> all() {
      * the provided name.
      *
      * @param name the name of the breed
+     * @return the new {@link Breed} entity
      */
     @POST
     @Path("/{name}")
@@ -96,6 +101,7 @@ public Breed insert(@PathParam("name") String name) {
      * Handles the {@code DELETE /{id}} request and deletes a {@link Breed} entity by its ID.
      *
      * @param id the id of the breed
+     * @return the {@link Breed} entity delete operation result
      */
     @DELETE
     @Path("/{id}")

examples/data/mp/src/main/java/io/helidon/examples/data/mp/service/OwnerService.java

@@ -55,6 +55,8 @@ public OwnerService(OwnerRepository ownerRepository) {
 
     /**
      * Handles the {@code GET /} request and returns the index page with endpoint information.
+     *
+     * @return the index page with endpoint information
      */
     @GET
     @Produces(MediaTypes.TEXT_PLAIN_VALUE)
@@ -70,6 +72,8 @@ public String index() {
 
     /**
      * Handles the {@code GET /all} request and returns a list of all {@link Owner} entities.
+     *
+     * @return the list of all {@link Owner} entities
      */
     @GET
     @Path("/all")
@@ -83,6 +87,7 @@ public List<Owner> all() {
      * have a breed with the specified name.
      *
      * @param breed the name of the pet's breed
+     * @return the list of owner names
      */
     @GET
     @Path("/names/{breed}")
@@ -96,6 +101,7 @@ public List<String> namesByBreed(@PathParam("breed") String breed) {
      * the provided name.
      *
      * @param name the name of the owner
+     * @return the new {@link Owner} entity
      */
     @POST
     @Path("/{name}")
@@ -110,6 +116,7 @@ public Owner insert(@PathParam("name") String name) {
      * the specified ID.
      *
      * @param id the id of the owner
+     * @return the {@link Owner} entity delete operation result
      */
     @DELETE
     @Path("/{id}")

examples/data/mp/src/main/java/io/helidon/examples/data/mp/service/PetService.java

@@ -56,6 +56,13 @@ public class PetService {
     // Helidon Data repository interface providing Owner entity operations.
     private final OwnerRepository ownerRepository;
 
+    /**
+     * Constructs a new {@link PetService} instance.
+     *
+     * @param petRepository {@link Pet} entity data repository
+     * @param breedRepository {@link Breed} entity data repository
+     * @param ownerRepository {@link Owner} entity data repository
+     */
     @Inject
     public PetService(PetRepository petRepository,
                BreedRepository breedRepository,
@@ -67,6 +74,8 @@ public PetService(PetRepository petRepository,
 
     /**
      * Handles the {@code GET /} request and returns the index page with endpoint information.
+     *
+     * @return the index page with endpoint information
      */
     @GET
     @Produces(MediaTypes.TEXT_PLAIN_VALUE)
@@ -88,6 +97,8 @@ public String index() {
 
     /**
      * Handles the {@code GET /all} request and returns a list of all {@link Pet} entities.
+     *
+     * @return the list of all {@link Pet} entities
      */
     @GET
     @Path("/all")
@@ -103,6 +114,7 @@ public List<Pet> all() {
      * The page size is fixed at 5. The page index starts from 0.
      *
      * @param page the page number, starting from {@code 0}
+     * @return the paginated list of all {@link Pet} entities
      */
     @GET
     @Path("/all/{page}")
@@ -117,6 +129,7 @@ public PageDto<Pet> allPage(@PathParam("page") int page) {
      * associated with a specific breed name.
      *
      * @param name the name of the pet's breed
+     * @return the list of {@link Pet} entities associated with a specific breed name
      */
     @GET
     @Path("/breed/{name}")
@@ -129,6 +142,7 @@ public List<Pet> breed(@PathParam("name") String name) {
      * Handles the {@code GET /get/{name}} request and returns a {@link Pet} entity by its name.
      *
      * @param name the name of the pet
+     * @return a {@link Pet} entity with matching name or {@link Optional#empty()} when no such entity exists
      */
     @GET
     @Path("/get/{name}")
@@ -145,6 +159,7 @@ public Optional<Pet> pet(@PathParam("name") String name) {
      * Pet breed and owner records must already exist. Pet entity must not exist in the database.
      *
      * @param petDto the pet to insert into the database
+     * @return the new {@link Pet} entity
      */
     @POST
     @Consumes(MediaTypes.APPLICATION_JSON_VALUE)
@@ -168,6 +183,7 @@ public Pet insert(PetDto petDto) {
      * Handles the {@code DELETE /{id}} request and deletes a {@link Pet} entity by its ID.
      *
      * @param id the id of the pet
+     * @return the {@link Pet} entity delete operation result
      */
     @DELETE
     @Path("/{id}")

examples/data/se-declarative/src/main/java/io/helidon/examples/data/se/declarative/service/PetService.java

@@ -20,20 +20,16 @@
 
 import io.helidon.common.media.type.MediaTypes;
 import io.helidon.data.PageRequest;
-import io.helidon.data.Slice;
 import io.helidon.examples.data.se.declarative.model.Breed;
 import io.helidon.examples.data.se.declarative.model.Owner;
 import io.helidon.examples.data.se.declarative.model.Pet;
 import io.helidon.examples.data.se.declarative.repository.BreedRepository;
 import io.helidon.examples.data.se.declarative.repository.OwnerRepository;
 import io.helidon.examples.data.se.declarative.repository.PetRepository;
-import io.helidon.http.BadRequestException;
 import io.helidon.http.Http;
 import io.helidon.service.registry.Service;
 import io.helidon.transaction.Tx;
 import io.helidon.webserver.http.RestServer;
-import io.helidon.webserver.http.ServerRequest;
-import io.helidon.webserver.http.ServerResponse;
 
 /**
  * Service class responsible for handling HTTP requests related to {@link Pet} entities.
@@ -108,6 +104,7 @@ List<Pet> all() {
      * The page size is fixed at 5. The page index starts from 0.
      *
      * @param page the page number, starting from {@code 0}
+     * @return the paginated list of all {@link Pet} entities
      */
     @Http.GET
     @Http.Path("/all/{page}")
@@ -122,6 +119,7 @@ PageDto<Pet> allPage(@Http.PathParam("page") int page) {
      * associated with a specific breed name.
      *
      * @param name the name of the pet's breed
+     * @return the list of {@link Pet} entities associated with a specific breed name
      */
     @Http.GET
     @Http.Path("/breed/{name}")
@@ -134,6 +132,7 @@ List<Pet> breed(@Http.PathParam("name") String name) {
      * Handles the {@code GET /get/{name}} request and returns a {@link Pet} entity by its name.
      *
      * @param name the name of the pet
+     * @return a {@link Pet} entity with matching name or {@link Optional#empty()} when no such entity exists
      */
     @Http.GET
     @Http.Path("/get/{name}")
@@ -150,6 +149,7 @@ Optional<Pet> pet(@Http.PathParam("name") String name) {
      * Pet breed and owner records must already exist. Pet entity must not exist in the database.
      *
      * @param petDto the pet to insert into the database
+     * @return the new {@link Pet} entity
      */
     @Http.POST
     @Http.Consumes(MediaTypes.APPLICATION_JSON_VALUE)
@@ -173,6 +173,7 @@ Pet insert(@Http.Entity PetDto petDto) {
      * Handles the {@code DELETE /{id}} request and deletes a {@link Pet} entity by its ID.
      *
      * @param id the id of the pet
+     * @return the {@link Pet} entity delete operation result
      */
     @Http.DELETE
     @Http.Path("/{id}")

examples/data/se-imperative/src/main/java/io/helidon/examples/data/se/imperative/service/PetService.java

@@ -17,7 +17,6 @@
 
 import io.helidon.common.media.type.MediaTypes;
 import io.helidon.data.PageRequest;
-import io.helidon.data.Slice;
 import io.helidon.examples.data.se.imperative.model.Breed;
 import io.helidon.examples.data.se.imperative.model.Owner;
 import io.helidon.examples.data.se.imperative.model.Pet;