Top Description Methods
org.hibernate.graph.spi

public Interface GraphImplementor<J>

extends Graph<J>, GraphNodeImplementor<J>
Known Direct Subinterfaces
org.hibernate.graph.spi.RootGraphImplementor, org.hibernate.graph.spi.SubGraphImplementor
Known Direct Implementers
org.hibernate.graph.internal.AbstractGraph
Imports
java.util.List, java.util.function.Consumer, org.hibernate.graph.AttributeNode, .CannotBecomeEntityGraphException, .CannotContainSubGraphException, .Graph, org.hibernate.metamodel.model.domain.PersistentAttribute

Integration version of the Graph contract
Authors
Strong Liu, Steve Ebersole, Andrea Boriero

Method Summary

Modifier and TypeMethod and Description
public AttributeNodeImplementor<?>
public <AJ> AttributeNodeImplementor<AJ>
addAttributeNode(String attributeName)

Redeclares org.hibernate.graph.Graph.addAttributeNode.

Add an AttributeNode (with no associated SubGraph) to this container by attribute name.
public <AJ> AttributeNodeImplementor<AJ>
addAttributeNode(PersistentAttribute<? extends J, AJ> attribute)

Redeclares org.hibernate.graph.Graph.addAttributeNode.

Add an AttributeNode (with no associated SubGraph) to this container by attribute reference.
public default <AJ> SubGraphImplementor<AJ>
public default <AJ> SubGraphImplementor<AJ>
public default <AJ> SubGraphImplementor<AJ>
public default <AJ> SubGraphImplementor<? extends AJ>
addKeySubGraph(PersistentAttribute<? extends J, AJ> attribute, Class<? extends AJ> subType)

Implements org.hibernate.graph.Graph.addKeySubGraph.

public default <AJ> SubGraphImplementor<AJ>
addSubGraph(String attributeName)

Implements org.hibernate.graph.Graph.addSubGraph.

Create and return a new (mutable) SubGraph associated with the named AttributeNode.
public default <AJ> SubGraphImplementor<AJ>
addSubGraph(String attributeName, Class<AJ> subType)

Implements org.hibernate.graph.Graph.addSubGraph.

public default <AJ> SubGraphImplementor<AJ>
addSubGraph(PersistentAttribute<? extends J, AJ> attribute)

Implements org.hibernate.graph.Graph.addSubGraph.

Create and return a new (mutable) SubGraph associated with the AttributeNode for the given attribute.
public default <AJ> SubGraphImplementor<? extends AJ>
addSubGraph(PersistentAttribute<? extends J, AJ> attribute, Class<? extends AJ> subType)

Implements org.hibernate.graph.Graph.addSubGraph.

public <AJ> AttributeNodeImplementor<AJ>
findAttributeNode(String attributeName)

Redeclares org.hibernate.graph.Graph.findAttributeNode.

Find an already existing AttributeNode by attributeName within this container
public <AJ> AttributeNodeImplementor<AJ>
findAttributeNode(PersistentAttribute<? extends J, AJ> attribute)

Redeclares org.hibernate.graph.Graph.findAttributeNode.

Find an already existing AttributeNode by corresponding attribute reference, within this container.
public default <AJ> AttributeNodeImplementor<AJ>
public <AJ> AttributeNodeImplementor<AJ>
findOrCreateAttributeNode(PersistentAttribute<? extends J, AJ> attribute)

public List<AttributeNodeImplementor<?>>
public default List<AttributeNode<?>>
getAttributeNodeList()

Implements org.hibernate.graph.Graph.getAttributeNodeList.

Get a list of all existing AttributeNodes within this container.
public GraphImplementor<J>
public RootGraphImplementor<J>
makeRootGraph(String name, boolean
controls whether the resulting Graph is mutable
mutable
)

Redeclares org.hibernate.graph.Graph.makeRootGraph.

Create a named root Graph if the given name is not null.
public SubGraphImplementor<J>
makeSubGraph(boolean mutable)

Redeclares org.hibernate.graph.Graph.makeSubGraph.

Create a new (mutable or immutable) SubGraph rooted at this Graph.
public void
merge(GraphImplementor<? extends J> other)

public default void
Inherited from org.hibernate.graph.Graph:
addPluralSubgraphgetGraphAttributeNodesgetGraphedType

Method Detail

addAttributeNodeback to summary
public AttributeNodeImplementor<?> addAttributeNode(AttributeNodeImplementor<?> makeCopy)
addAttributeNodeback to summary
public <AJ> AttributeNodeImplementor<AJ> addAttributeNode(String attributeName) throws CannotContainSubGraphException

Redeclares org.hibernate.graph.Graph.addAttributeNode.

Doc from org.hibernate.graph.Graph.addAttributeNode.

Add an AttributeNode (with no associated SubGraph) to this container by attribute name.

Annotations
@Override
addAttributeNodeback to summary
public <AJ> AttributeNodeImplementor<AJ> addAttributeNode(PersistentAttribute<? extends J, AJ> attribute) throws CannotContainSubGraphException

Redeclares org.hibernate.graph.Graph.addAttributeNode.

Doc from org.hibernate.graph.Graph.addAttributeNode.

Add an AttributeNode (with no associated SubGraph) to this container by attribute reference.

Annotations
@Override
addKeySubGraphback to summary
public default <AJ> SubGraphImplementor<AJ> addKeySubGraph(String attributeName)

Implements org.hibernate.graph.Graph.addKeySubGraph.

Annotations
@Override
@SuppressWarnings:unchecked
addKeySubGraphback to summary
public default <AJ> SubGraphImplementor<AJ> addKeySubGraph(String attributeName, Class<AJ> subtype)

Implements org.hibernate.graph.Graph.addKeySubGraph.

Annotations
@Override
addKeySubGraphback to summary
public default <AJ> SubGraphImplementor<AJ> addKeySubGraph(PersistentAttribute<? extends J, AJ> attribute)

Implements org.hibernate.graph.Graph.addKeySubGraph.

Annotations
@Override
addKeySubGraphback to summary
public default <AJ> SubGraphImplementor<? extends AJ> addKeySubGraph(PersistentAttribute<? extends J, AJ> attribute, Class<? extends AJ> subType) throws CannotContainSubGraphException

Implements org.hibernate.graph.Graph.addKeySubGraph.

Annotations
@Override
addSubGraphback to summary
public default <AJ> SubGraphImplementor<AJ> addSubGraph(String attributeName) throws CannotContainSubGraphException

Implements org.hibernate.graph.Graph.addSubGraph.

Doc from org.hibernate.graph.Graph.addSubGraph.

Create and return a new (mutable) SubGraph associated with the named AttributeNode.

Annotations
@Override
@SuppressWarnings:unchecked
addSubGraphback to summary
public default <AJ> SubGraphImplementor<AJ> addSubGraph(String attributeName, Class<AJ> subType) throws CannotContainSubGraphException

Implements org.hibernate.graph.Graph.addSubGraph.

Annotations
@Override
addSubGraphback to summary
public default <AJ> SubGraphImplementor<AJ> addSubGraph(PersistentAttribute<? extends J, AJ> attribute) throws CannotContainSubGraphException

Implements org.hibernate.graph.Graph.addSubGraph.

Doc from org.hibernate.graph.Graph.addSubGraph.

Create and return a new (mutable) SubGraph associated with the AttributeNode for the given attribute.

Annotations
@Override
addSubGraphback to summary
public default <AJ> SubGraphImplementor<? extends AJ> addSubGraph(PersistentAttribute<? extends J, AJ> attribute, Class<? extends AJ> subType) throws CannotContainSubGraphException

Implements org.hibernate.graph.Graph.addSubGraph.

Annotations
@Override
findAttributeNodeback to summary
public <AJ> AttributeNodeImplementor<AJ> findAttributeNode(String attributeName)

Redeclares org.hibernate.graph.Graph.findAttributeNode.

Doc from org.hibernate.graph.Graph.findAttributeNode.

Find an already existing AttributeNode by attributeName within this container

Annotations
@Override
findAttributeNodeback to summary
public <AJ> AttributeNodeImplementor<AJ> findAttributeNode(PersistentAttribute<? extends J, AJ> attribute)

Redeclares org.hibernate.graph.Graph.findAttributeNode.

Doc from org.hibernate.graph.Graph.findAttributeNode.

Find an already existing AttributeNode by corresponding attribute reference, within this container.

Annotations
@Override
findOrCreateAttributeNodeback to summary
public default <AJ> AttributeNodeImplementor<AJ> findOrCreateAttributeNode(String name)
Annotations
@SuppressWarnings:unchecked
findOrCreateAttributeNodeback to summary
public <AJ> AttributeNodeImplementor<AJ> findOrCreateAttributeNode(PersistentAttribute<? extends J, AJ> attribute)
getAttributeNodeImplementorsback to summary
public List<AttributeNodeImplementor<?>> getAttributeNodeImplementors()
getAttributeNodeListback to summary
public default List<AttributeNode<?>> getAttributeNodeList()

Implements org.hibernate.graph.Graph.getAttributeNodeList.

Doc from org.hibernate.graph.Graph.getAttributeNodeList.

Get a list of all existing AttributeNodes within this container.

Annotations
@Override
@SuppressWarnings:unchecked, rawtypes
makeCopyback to summary
public GraphImplementor<J> makeCopy(boolean mutable)

Redeclares org.hibernate.graph.Graph.makeCopy, org.hibernate.graph.spi.GraphNodeImplementor.makeCopy.

Annotations
@Override
makeRootGraphback to summary
public RootGraphImplementor<J> makeRootGraph(String name, boolean mutable) throws CannotBecomeEntityGraphException

Redeclares org.hibernate.graph.Graph.makeRootGraph.

Doc from org.hibernate.graph.Graph.makeRootGraph.

Create a named root Graph if the given name is not null.

Parameters
mutable:boolean

controls whether the resulting Graph is mutable

Annotations
@Override
Exceptions
CannotBecomeEntityGraphException:
If the named attribute is not entity-valued
makeSubGraphback to summary
public SubGraphImplementor<J> makeSubGraph(boolean mutable)

Redeclares org.hibernate.graph.Graph.makeSubGraph.

Doc from org.hibernate.graph.Graph.makeSubGraph.

Create a new (mutable or immutable) SubGraph rooted at this Graph.

Annotations
@Override
mergeback to summary
public void merge(GraphImplementor<? extends J> other)
visitAttributeNodesback to summary
public default void visitAttributeNodes(Consumer<AttributeNodeImplementor<?>> consumer)