Skip to content

Commit

Permalink
doc/issues-19(Adicionar Javadoc ao Projeto) 📝 Adicionar comentários J…
Browse files Browse the repository at this point in the history
…avadoc abrangentes aos mapeadores

- **Adicionar comentários Javadoc abrangentes aos mapeadores**

    Adicionados comentários Javadoc abrangentes a todas as classes e seus métodos dentro do pacote 'mapper' para melhorar a clareza e compreensão de suas funcionalidades.

- **Aumentar a legibilidade**

    Isso aumenta a legibilidade e fornece explicações detalhadas sobre os papéis, alcance e responsabilidades de cada classe.

- **Transformando e mapeando objetos de Produto**

    Explica como eles transformam e mapeiam objetos de Produto.
  • Loading branch information
diegosneves committed Mar 10, 2024
1 parent a43738a commit 192379c
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@

import java.lang.reflect.Field;

/**
* A interface BuilderMapper fornece métodos para mapear campos de um objeto de origem para um objeto de destino.
*
* @author diegosneves
*/
public interface BuilderMapper {

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
package diegosneves.github.hexagonal.app.mapper;

/**
* A interface {@link MapperStrategy} é utilizada para definir uma estratégia de mapeamento entre um objeto de origem do tipo E e um objeto de destino do tipo T.
*
* @param <T> O tipo do objeto de destino.
* @param <E> O tipo do objeto de origem.
*
* @author diegosneves
*/
public interface MapperStrategy <T, E> {

/**
* Mapeia um objeto do tipo E para um objeto do tipo T.
*
* @param origin O objeto a ser mapeado.
* @return O objeto mapeado.
*/
T mapper(E origin);

}
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@

import java.lang.reflect.Field;

/**
* A classe {@link ProductByCliEntityMapper} implementa a interface {@link MapperStrategy} e é responsável
* por mapear um objeto do tipo {@link ProductEntity} para um objeto do tipo {@link Product}.
*
* @author diegosneves
*/
public class ProductByCliEntityMapper implements MapperStrategy<Product, ProductEntity> {

private static final String STATUS_FIELD = "status";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
import diegosneves.github.hexagonal.adapters.cli.model.ProductEntity;
import diegosneves.github.hexagonal.app.domain.product.entity.ProductContract;

/**
* A classe {@link ProductEntityCLIMapper} implementa a interface {@link MapperStrategy} e é responsável por realizar a conversão de um objeto {@link ProductContract} para um objeto {@link ProductEntity}.
*
* @author diegosneves
*/
public class ProductEntityCLIMapper implements MapperStrategy<ProductEntity, ProductContract> {

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
import diegosneves.github.hexagonal.adapters.rest.model.ProductEntity;
import diegosneves.github.hexagonal.app.domain.product.entity.ProductContract;

/**
* A classe {@link ProductEntityMapper} realiza a transformação de um objeto {@link ProductContract} em um objeto {@link ProductEntity}.
* Através da implementação da interface {@link MapperStrategy}, esta classe define como essa transformação entre os dois tipos de objeto será executada.
* <p>
* Este processo é essencial para a correta conversão dos dados do contrato do produto para a sua representação no banco de dados, permitindo a correta persistência e manipulação dos mesmos.
*
* @author diegosneves
*/
public class ProductEntityMapper implements MapperStrategy<ProductEntity, ProductContract> {

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@

import java.lang.reflect.Field;

/**
* A classe {@link ProductMapper} implementa a interface {@link MapperStrategy} para definir uma estratégia de mapeamento entre um objeto {@link Product} e um objeto {@link ProductEntity}.
*
* @author diegosneves
*/
public class ProductMapper implements MapperStrategy<Product, ProductEntity> {

private static final String STATUS_FIELD = "status";
Expand Down

0 comments on commit 192379c

Please sign in to comment.