Package io.jmix.core.repository

Record Class JmixDataRepositoryContext

java.lang.Object

java.lang.Record

io.jmix.core.repository.JmixDataRepositoryContext

Record Components:

fetchPlan - FetchPlan to load entities with. Default value: FetchPlan.BASE

condition - Condition to filter entities

hints - query hints, e.g. from io.jmix.data.PersistenceHints

All Implemented Interfaces:

Serializable

public record JmixDataRepositoryContext(FetchPlan fetchPlan, Condition condition, Map<String,Serializable> hints)
extends Record
implements Serializable

Accumulates jmix-specific parameters. Supported by standard JmixDataRepository methods and as query parameter.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JmixDataRepositoryContext.Builder

Constructor Summary

Constructors

Constructor	Description
JmixDataRepositoryContext(FetchPlan fetchPlan, Condition condition, Map<String,Serializable> hints)	Creates an instance of a JmixDataRepositoryContext record class.

Method Summary

Modifier and Type	Method	Description
static JmixDataRepositoryContext.Builder	builder()
Condition	condition()	Returns the value of the condition record component.
static JmixDataRepositoryContext.Builder	condition(Condition condition)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
FetchPlan	fetchPlan()	Returns the value of the fetchPlan record component.
final int	hashCode()	Returns a hash code value for this object.
Map<String,Serializable>	hints()	Returns the value of the hints record component.
static JmixDataRepositoryContext.Builder	hints(Map<String,Serializable> hints)
static JmixDataRepositoryContext	of(FetchPlan fetchPlan)
static JmixDataRepositoryContext	of(Condition condition)
static JmixDataRepositoryContext	of(Map<String,Serializable> hints)
static JmixDataRepositoryContext.Builder	plan(FetchPlan fetchPlan)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

JmixDataRepositoryContext

public JmixDataRepositoryContext(@Nullable
 FetchPlan fetchPlan,
 @Nullable
 Condition condition,
 @Nullable
 Map<String,Serializable> hints)

Creates an instance of a JmixDataRepositoryContext record class.

Parameters:

fetchPlan - the value for the fetchPlan record component

condition - the value for the condition record component

hints - the value for the hints record component

Method Details

hints

public Map<String,Serializable> hints()

Returns the value of the hints record component.

Returns:

the value of the hints record component

builder

public static JmixDataRepositoryContext.Builder builder()

Returns:

a new builder for JmixDataRepositoryContext.

plan

public static JmixDataRepositoryContext.Builder plan(@Nullable
 FetchPlan fetchPlan)

Returns:

a new builder for JmixDataRepositoryContext with specified fetchPlan.

condition

public static JmixDataRepositoryContext.Builder condition(@Nullable
 Condition condition)

Returns:

a new builder for JmixDataRepositoryContext with specified condition.

hints

public static JmixDataRepositoryContext.Builder hints(@Nullable
 Map<String,Serializable> hints)

Returns:

a new builder for JmixDataRepositoryContext with specified hints.

of

public static JmixDataRepositoryContext of(FetchPlan fetchPlan)

Returns:

a new JmixDataRepositoryContext with specified fetchPlan.

of

public static JmixDataRepositoryContext of(Condition condition)

Returns:

a new JmixDataRepositoryContext with specified condition.

of

public static JmixDataRepositoryContext of(Map<String,Serializable> hints)

Returns:

a new JmixDataRepositoryContext with specified hints.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

fetchPlan

@Nullable
public FetchPlan fetchPlan()

Returns the value of the fetchPlan record component.

Returns:

the value of the fetchPlan record component

condition

@Nullable
public Condition condition()

Returns the value of the condition record component.

Returns:

the value of the condition record component