diff --git a/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/Pokemon.java b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/Pokemon.java index a2ba2c373..27300d946 100644 --- a/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/Pokemon.java +++ b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/Pokemon.java @@ -52,6 +52,9 @@ public class Pokemon { private int type; + /** + * Creates a new pokemon. + */ public Pokemon() { } @@ -75,11 +78,21 @@ public class Pokemon { this.name = name; } + /** + * Returns pokemon's type. + * + * @return Pokemon's type. + */ @ManyToOne public PokemonType getPokemonType() { return pokemonType; } + /** + * Sets pokemon's type. + * + * @param pokemonType Pokemon's type. + */ public void setPokemonType(PokemonType pokemonType) { this.pokemonType = pokemonType; this.type = pokemonType.getId(); diff --git a/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonResource.java b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonResource.java index 92eff279e..f300def63 100644 --- a/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonResource.java +++ b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonResource.java @@ -15,6 +15,8 @@ */ package io.helidon.examples.integrations.cdi.pokemon; +import java.util.List; + import javax.persistence.EntityManager; import javax.persistence.PersistenceContext; import javax.persistence.TypedQuery; @@ -29,7 +31,6 @@ import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; -import java.util.List; /** * This class implements REST endpoints to interact with Pokemons. The following @@ -47,12 +48,24 @@ public class PokemonResource { @PersistenceContext(unitName = "test") private EntityManager entityManager; + /** + * Retrieves list of all pokemons. + * + * @return List of pokemons. + */ @GET @Produces(MediaType.APPLICATION_JSON) public List getPokemons() { return entityManager.createNamedQuery("getPokemons", Pokemon.class).getResultList(); } + /** + * Retrieves single pokemon by ID. + * + * @param id The ID. + * @return A pokemon that matches the ID. + * @throws NotFoundException If no pokemon found for the ID. + */ @GET @Path("{id}") @Produces(MediaType.APPLICATION_JSON) @@ -64,6 +77,11 @@ public class PokemonResource { } } + /** + * Deletes a single pokemon by ID. + * + * @param id The ID. + */ @DELETE @Path("{id}") @Produces(MediaType.APPLICATION_JSON) @@ -73,6 +91,13 @@ public class PokemonResource { entityManager.remove(pokemon); } + /** + * Retrieves a pokemon by name. + * + * @param name The name. + * @return A pokemon that matches the name. + * @throws NotFoundException If no pokemon found for the name. + */ @GET @Path("name/{name}") @Produces(MediaType.APPLICATION_JSON) @@ -85,6 +110,12 @@ public class PokemonResource { return list.get(0); } + /** + * Creates a new pokemon. + * + * @param pokemon New pokemon. + * @throws BadRequestException If a problem was found. + */ @POST @Consumes(MediaType.APPLICATION_JSON) @Transactional(Transactional.TxType.REQUIRED) @@ -99,3 +130,4 @@ public class PokemonResource { } } } + diff --git a/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonType.java b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonType.java index b221d9345..0c1e9fde1 100644 --- a/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonType.java +++ b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonType.java @@ -47,6 +47,9 @@ public class PokemonType { @Column(name = "NAME") private String name; + /** + * Creates a new type. + */ public PokemonType() { } diff --git a/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonTypeResource.java b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonTypeResource.java index 8122d0f83..67bd76237 100644 --- a/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonTypeResource.java +++ b/examples/integrations/cdi/pokemons/src/main/java/io/helidon/examples/integrations/cdi/pokemon/PokemonTypeResource.java @@ -15,13 +15,14 @@ */ package io.helidon.examples.integrations.cdi.pokemon; +import java.util.List; + import javax.persistence.EntityManager; import javax.persistence.PersistenceContext; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; -import java.util.List; /** * This class implements a REST endpoint to retrieve Pokemon types.