Module spring.data.jpa

Package org.springframework.data.jpa.repository.query

Class JpaEntityGraph

java.lang.Object

org.springframework.data.jpa.repository.query.JpaEntityGraph

public class JpaEntityGraph
extends Object

EntityGraph configuration for JPA 2.1 EntityGraphs.

Since:

1.6

Author:

Thomas Darimont, Mark Paluch, Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
JpaEntityGraph(String name, EntityGraph.EntityGraphType type, String[] attributePaths)	Creates an JpaEntityGraph with the given name, EntityGraph.EntityGraphType and attribute paths.
JpaEntityGraph(EntityGraph entityGraph, String nameFallback)	Creates an JpaEntityGraph.

Method Summary

Modifier and Type	Method	Description
List<String>	getAttributePaths()	Returns the attribute node names to be used for this JpaEntityGraph.
String	getName()	Returns the name of the EntityGraph configuration to use.
EntityGraph.EntityGraphType	getType()	Returns the EntityGraph.EntityGraphType of the EntityGraph to use.
boolean	isAdHocEntityGraph()	Deprecated, for removal: This API element is subject to removal in a future version. since 3.5 as the used evaluation does not represent whether a JpaEntityGraph is dynamic or not.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

JpaEntityGraph

public JpaEntityGraph(EntityGraph entityGraph,
 String nameFallback)

Creates an JpaEntityGraph.

Parameters:

entityGraph - must not be null.

nameFallback - must not be null or empty.

JpaEntityGraph

public JpaEntityGraph(String name,
 EntityGraph.EntityGraphType type,
 @Nullable
 String[] attributePaths)

Creates an JpaEntityGraph with the given name, EntityGraph.EntityGraphType and attribute paths.

Parameters:

name - must not be null or empty.

type - must not be null.

attributePaths - may be null.

Since:

1.9

Method Details

getName

public String getName()

Returns the name of the EntityGraph configuration to use.

Returns:

getType

public EntityGraph.EntityGraphType getType()

Returns the EntityGraph.EntityGraphType of the EntityGraph to use.

Returns:

getAttributePaths

public List<String> getAttributePaths()

Returns the attribute node names to be used for this JpaEntityGraph.

Returns:

Since:

1.9

isAdHocEntityGraph

@Deprecated(since="3.5",
            forRemoval=true)
public boolean isAdHocEntityGraph()

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.5 as the used evaluation does not represent whether a JpaEntityGraph is dynamic or not.

Return true if this JpaEntityGraph needs to be generated on-the-fly.

Returns:

true if attributePaths is not empty.

Since:

1.9

toString

public String toString()

Overrides:

toString in class Object