Skip to content

Commit 93fb78f

Browse files
committed
docs: add missing javadocs
1 parent fc93293 commit 93fb78f

File tree

29 files changed

+165
-1
lines changed

29 files changed

+165
-1
lines changed

backend-core-business-impl/src/main/java/com/flowingcode/backendcore/service/validation/CreationValidator.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@
2828
import com.flowingcode.backendcore.model.ErrorDescription;
2929
import com.flowingcode.backendcore.validation.Validator;
3030

31+
/**
32+
* Validator for creation operations on entities.
33+
*
34+
* @param <T> the type being validated
35+
* @author mlopez
36+
*/
3137
public interface CreationValidator<T> extends Validator<T> {
3238

3339
default CreationValidator<T> and(CreationValidator<T> then) {

backend-core-business-impl/src/main/java/com/flowingcode/backendcore/service/validation/DeletionValidator.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@
2828
import com.flowingcode.backendcore.model.ErrorDescription;
2929
import com.flowingcode.backendcore.validation.Validator;
3030

31+
/**
32+
* Validator for deletion operations on entities.
33+
*
34+
* @param <T> the type being validated
35+
* @author mlopez
36+
*/
3137
public interface DeletionValidator<T> extends Validator<T> {
3238

3339
default DeletionValidator<T> and(DeletionValidator<T> then) {

backend-core-business-impl/src/main/java/com/flowingcode/backendcore/service/validation/InvariantValidator.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@
1010
import com.flowingcode.backendcore.service.validation.UpdateValidator;
1111
import com.flowingcode.backendcore.validation.Validator;
1212

13+
/**
14+
* Validator that enforces invariants during both creation and update operations.
15+
*
16+
* @param <T> the type being validated
17+
* @author jgodoy
18+
*/
1319
public interface InvariantValidator<T> extends CreationValidator<T>, UpdateValidator<T> {
1420

1521
default InvariantValidator<T> and(InvariantValidator<T> then) {

backend-core-business-impl/src/main/java/com/flowingcode/backendcore/service/validation/ServiceValidationKind.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
import lombok.Getter;
77
import lombok.RequiredArgsConstructor;
88

9+
/**
10+
* Enumeration of service validation kinds corresponding to different operation types.
11+
*
12+
* @author mlopez
13+
*/
914
@RequiredArgsConstructor
1015
public enum ServiceValidationKind implements ValidationKind {
1116

backend-core-business-impl/src/main/java/com/flowingcode/backendcore/service/validation/UpdateValidator.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@
2828
import com.flowingcode.backendcore.model.ErrorDescription;
2929
import com.flowingcode.backendcore.validation.Validator;
3030

31+
/**
32+
* Validator for update operations on entities.
33+
*
34+
* @param <T> the type being validated
35+
* @author mlopez
36+
*/
3137
public interface UpdateValidator<T> extends Validator<T> {
3238

3339
default UpdateValidator<T> and(UpdateValidator<T> then) {

backend-core-business-spring-impl/src/main/java/com/flowingcode/backendcore/service/ConstraintSpecification.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@
1313
import lombok.AccessLevel;
1414
import lombok.RequiredArgsConstructor;
1515

16+
/**
17+
* Spring Data JPA {@link org.springframework.data.jpa.domain.Specification} that applies a model {@link com.flowingcode.backendcore.model.Constraint}.
18+
*
19+
* @param <T> the entity type
20+
* @author jgodoy
21+
*/
1622
@SuppressWarnings("serial")
1723
@RequiredArgsConstructor(access = AccessLevel.PRIVATE)
1824
final class ConstraintSpecification<T> implements Specification<T> {

backend-core-data-impl/src/main/java/com/flowingcode/backendcore/dao/jpa/ConstraintTransformerJpaImpl.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@
4444
import lombok.NonNull;
4545
import lombok.RequiredArgsConstructor;
4646

47+
/**
48+
* JPA implementation of {@link com.flowingcode.backendcore.model.ConstraintTransformer} for converting model constraints into JPA {@link jakarta.persistence.criteria.Predicate} instances.
49+
*
50+
* @author jgodoy
51+
*/
4752
@RequiredArgsConstructor
4853
public class ConstraintTransformerJpaImpl extends ConstraintTransformer<Predicate> {
4954

backend-core-data-impl/src/main/java/com/flowingcode/backendcore/dao/jpa/ConversionJpaDaoSupport.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,14 @@
3939
import com.flowingcode.backendcore.model.Identifiable;
4040
import com.flowingcode.backendcore.model.QuerySpec;
4141

42+
/**
43+
* DAO support interface that converts between source domain type S and persistent entity type T and provides generic CRUD operations.
44+
*
45+
* @param <S> the source domain type
46+
* @param <T> the persistent entity type
47+
* @param <K> the identifier type
48+
* @author mlopez
49+
*/
4250
public interface ConversionJpaDaoSupport<S, T extends Identifiable<K>, K extends Serializable>
4351
extends CrudDao<S, K> {
4452

backend-core-data-impl/src/main/java/com/flowingcode/backendcore/dao/jpa/JpaDaoSupport.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@
2323

2424
import com.flowingcode.backendcore.model.Identifiable;
2525

26+
/**
27+
* DAO support interface for JPA entities, providing default identity conversions.
28+
*
29+
* @param <T> the persistent entity type
30+
* @param <K> the identifier type
31+
* @author mlopez
32+
*/
2633
public interface JpaDaoSupport<T extends Identifiable<K>, K extends Serializable>
2734
extends ConversionJpaDaoSupport<T, T, K> {
2835

backend-core-data/src/main/java/com/flowingcode/backendcore/dao/CreationDao.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@
1919
*/
2020
package com.flowingcode.backendcore.dao;
2121

22+
/**
23+
* Data access interface for creating entities of type T.
24+
*
25+
* @param <T> the entity type
26+
* @param <K> the identifier type returned upon creation
27+
* @author mlopez
28+
*/
2229
public interface CreationDao<T, K> {
2330

2431
K save(T entity);

0 commit comments

Comments
 (0)