Skip to content

Commit 114d96e

Browse files
committed
HHH-19364 add a little bit of additional jdoc
1 parent 1f57aae commit 114d96e

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

hibernate-core/src/main/java/org/hibernate/query/programmatic/QuerySpecification.java

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,22 @@
1616

1717
/**
1818
* Commonality for all query specifications which allow iterative,
19-
* programmatic building of a query.
19+
* programmatic building of a query. A specification allows
20+
* {@linkplain #restrict restrictions},
21+
* {@linkplain SelectionSpecification#restrict sorting}, and
22+
* {@linkplain SelectionSpecification#fetch fetching} to be added to
23+
* a predefined HQL or criteria query.
24+
* <ul>
25+
* <li>{@link #createQuery(EntityManager)} obtains an executable
26+
* query object associated with the given session.
27+
* <li>{@link #buildCriteria(CriteriaBuilder)} transforms the
28+
* specification to a {@link CommonAbstractCriteria criteria query}.
29+
* <li>{@link #validate(CriteriaBuilder)} validates the query without
30+
* executing it.
31+
* </ul>
32+
* <p>
33+
* This is the abstract base type of {@link SelectionSpecification}
34+
* and {@link MutationSpecification}.
2035
*
2136
* @apiNote Query specifications only support a single root entity.
2237
*

0 commit comments

Comments
 (0)