Skip to content

Commit 101300c

Browse files
committed
feat: update documentation at Hazelcastrepository
Signed-off-by: Otavio Santana <[email protected]>
1 parent acc700e commit 101300c

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

jnosql-hazelcast/src/main/java/org/eclipse/jnosql/databases/hazelcast/mapping/HazelcastRepository.java

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,29 @@
1818
import org.eclipse.jnosql.mapping.NoSQLRepository;
1919

2020
/**
21-
* The hazelcast {@link NoSQLRepository}
21+
* A Hazelcast-specific extension of {@link NoSQLRepository}, providing
22+
* key-value data storage and retrieval using Hazelcast.
23+
* <p>
24+
* This repository interface allows for defining custom queries using
25+
* {@link Query} annotations and enables CRUD operations for entities.
26+
* </p>
27+
*
28+
* Example usage:
29+
* <pre>
30+
* {@code
31+
* @Repository
32+
* interface ProductRepository extends HazelcastRepository<Product, String> {
33+
*
34+
* @Query("category = :category")
35+
* Set<Product> findByCategory(@Param("category") String category);
36+
* }
37+
* }
38+
* </pre>
2239
*
2340
* @param <T> the entity type
24-
* @param <K> the id entity type
41+
* @param <K> the identifier type
42+
* @see Query
43+
* @see NoSQLRepository
2544
*/
2645
public interface HazelcastRepository<T, K> extends NoSQLRepository<T, K> {
2746
}

0 commit comments

Comments
 (0)