Top Description Inners Fields Constructors Methods
org.hibernate.engine.profile

public Class Fetch

extends Object
Class Inheritance
Imports
org.hibernate.AssertionFailure, org.hibernate.annotations.FetchMode, org.hibernate.engine.FetchStyle, .FetchTiming, java.util.Locale

Models an individual fetch override within a FetchProfile.
Author
Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
Fetch.Style

Deprecated for removal. Use FetchStyle
The type or style of fetch.

Field Summary

Modifier and TypeField and Description
private final Association
private final FetchStyle
private final FetchTiming

Constructor Summary

AccessConstructor and Description
public
Fetch(Association
The association to be fetched
association
,
Fetch.Style
How to fetch it
style
)

Deprecated for removal. use Fetch(Association, FetchStyle, FetchTiming)
Constructs a Fetch.
public
Fetch(Association
The association to be fetched
association
,
FetchStyle
How to fetch it
method
,
FetchTiming timing)

Constructs a Fetch.

Method Summary

Modifier and TypeMethod and Description
public Association
getAssociation()

The association to which the fetch style applies.

public FetchStyle
getMethod()

The fetch method to be applied to the association.

public Fetch.Style
getStyle()

Deprecated for removal. use getMethod()
The fetch style applied to the association.
public FetchTiming
getTiming()

The fetch timing to be applied to the association.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

associationback to summary
private final Association association
methodback to summary
private final FetchStyle method
timingback to summary
private final FetchTiming timing

Constructor Detail

Fetchback to summary
public Fetch(Association association, Fetch.Style style)

Constructs a Fetch.

Parameters
association:Association

The association to be fetched

style:Fetch.Style

How to fetch it

Annotations
@Deprecated
forRemoval:true
Fetchback to summary
public Fetch(Association association, FetchStyle method, FetchTiming timing)

Constructs a Fetch.

Parameters
association:Association

The association to be fetched

method:FetchStyle

How to fetch it

Method Detail

getAssociationback to summary
public Association getAssociation()

The association to which the fetch style applies.

getMethodback to summary
public FetchStyle getMethod()

The fetch method to be applied to the association.

getStyleback to summary
public Fetch.Style getStyle()

Deprecated

for removal.

use getMethod()

The fetch style applied to the association.

Annotations
@Deprecated
forRemoval:true
getTimingback to summary
public FetchTiming getTiming()

The fetch timing to be applied to the association.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
org.hibernate.engine.profile back to summary

public final Enum Fetch.Style

extends Enum<Fetch.Style>
Class Inheritance
Annotations
@Deprecated
forRemoval:true

Deprecated

for removal.

Use FetchStyle

The type or style of fetch.

Field Summary

Modifier and TypeField and Description
public static final Fetch.Style
JOIN

Fetch via a join

public static final Fetch.Style
SELECT

Fetch via a subsequent select

public static final Fetch.Style
SUBSELECT

Fetch via a subsequent subselect

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static Fetch.Style
forMethod(FetchMode fetchMode)

Deprecated as a consequence of Fetch.Style being deprecated.
pack-priv static Fetch.Style
fromFetchStyle(FetchStyle fetchStyle)

Deprecated as a consequence of Fetch.Style being deprecated.
public static Fetch.Style

Returns:

The style; JOIN is returned if not recognized
parse
(String
The externalized representation
name
)

Deprecated as a consequence of Fetch.Style being deprecated.
Parses a style given an externalized string representation
public FetchStyle
public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.
public static Fetch.Style
valueOf(String name)

Deprecated as a consequence of Fetch.Style being deprecated.
public static Fetch.Style[]
values()

Deprecated as a consequence of Fetch.Style being deprecated.
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

JOINback to summary
public static final Fetch.Style JOIN

Deprecated

as a consequence of Fetch.Style being deprecated. See corresponding docs for further information.

Fetch via a join

SELECTback to summary
public static final Fetch.Style SELECT

Deprecated

as a consequence of Fetch.Style being deprecated. See corresponding docs for further information.

Fetch via a subsequent select

SUBSELECTback to summary
public static final Fetch.Style SUBSELECT

Deprecated

as a consequence of Fetch.Style being deprecated. See corresponding docs for further information.

Fetch via a subsequent subselect

Constructor Detail

Styleback to summary
private Style()

Method Detail

forMethodback to summary
public static Fetch.Style forMethod(FetchMode fetchMode)

Deprecated

as a consequence of Fetch.Style being deprecated. See corresponding docs for further information.

fromFetchStyleback to summary
pack-priv static Fetch.Style fromFetchStyle(FetchStyle fetchStyle)

Deprecated

as a consequence of Fetch.Style being deprecated. See corresponding docs for further information.

parseback to summary
public static Fetch.Style parse(String name)

Deprecated

as a consequence of Fetch.Style being deprecated. See corresponding docs for further information.

Parses a style given an externalized string representation

Parameters
name:String

The externalized representation

Returns:Fetch.Style

The style; JOIN is returned if not recognized

toFetchStyleback to summary
public FetchStyle toFetchStyle()
toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations
@Override
valueOfback to summary
public static Fetch.Style valueOf(String name)

Deprecated

as a consequence of Fetch.Style being deprecated. See corresponding docs for further information.

valuesback to summary
public static Fetch.Style[] values()

Deprecated

as a consequence of Fetch.Style being deprecated. See corresponding docs for further information.