Skip to content

Commit acc700e

Browse files
committed
docs: enhance hazelcast query documentation
Signed-off-by: Otavio Santana <[email protected]>
1 parent 3bab504 commit acc700e

File tree

1 file changed

+22
-1
lines changed
  • jnosql-hazelcast/src/main/java/org/eclipse/jnosql/databases/hazelcast/mapping

1 file changed

+22
-1
lines changed

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

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,32 @@
2020
import java.lang.annotation.Target;
2121

2222
/**
23-
* To a dynamic query on HazelcastRepository interfaces.
23+
* Annotation for defining a dynamic query method in Hazelcast repositories.
24+
* <p>
25+
* This annotation allows developers to specify Hazelcast query expressions
26+
* directly in repository methods.
27+
* </p>
28+
*
29+
* Example usage:
30+
* <pre>
31+
* {@code
32+
* @Repository
33+
* interface PersonRepository extends HazelcastRepository<Person, String> {
34+
*
35+
* @Query("age > 30")
36+
* List<Person> findAdults();
37+
* }
38+
* }
39+
* </pre>
2440
*/
2541
@Retention(RetentionPolicy.RUNTIME)
2642
@Target(ElementType.METHOD)
2743
public @interface Query {
2844

45+
/**
46+
* The Hazelcast query expression.
47+
*
48+
* @return the query string to be executed
49+
*/
2950
String value();
3051
}

0 commit comments

Comments
 (0)