Skip to content

Commit 6056ec9

Browse files
committed
add more info to javadoc of Graph
1 parent 573ccbc commit 6056ec9

File tree

1 file changed

+9
-0
lines changed
  • hibernate-core/src/main/java/org/hibernate/graph

1 file changed

+9
-0
lines changed

hibernate-core/src/main/java/org/hibernate/graph/Graph.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@
3232
* combine creation of a subgraph with creation of a treated subgraph.
3333
* <p>
3434
* Extends the JPA-defined {@link jakarta.persistence.Graph} with additional operations.
35+
* <p>
36+
* There are a range of ways to create {@code Graph}s:
37+
* <ul>
38+
* <li>programmatically, beginning with {@link org.hibernate.Session#createEntityGraph(Class)},
39+
* <li>using the {@link jakarta.persistence.NamedEntityGraph @NamedEntityGraph} annotation, or
40+
* <li>using the mini-language understood by {@link GraphParser}.
41+
* </ul>
3542
*
3643
* @apiNote Historically, both {@link jakarta.persistence.EntityGraph} and this interface
3744
* declared operations with incorrect generic types, leading to unsound code. This was
@@ -46,6 +53,8 @@
4653
* @see SubGraph
4754
* @see jakarta.persistence.EntityGraph
4855
* @see jakarta.persistence.Subgraph
56+
* @see GraphParser
57+
* @see EntityGraphs
4958
*/
5059
public interface Graph<J> extends GraphNode<J>, jakarta.persistence.Graph<J> {
5160

0 commit comments

Comments
 (0)