Package nl.datasteel.crudcraft.codegen.descriptor.field.part

Record Class SearchOptions

java.lang.Object

java.lang.Record

nl.datasteel.crudcraft.codegen.descriptor.field.part.SearchOptions

Record Components:

searchable - true if the field can be searched

operators - the supported search operators

depth - traversal depth for nested search

public record SearchOptions(boolean searchable, List<SearchOperator> operators, int depth)
extends Record

Search configuration for a field.

Constructor Summary

Constructors

Constructor	Description
SearchOptions(boolean searchable, List<SearchOperator> operators, int depth)	Immutable constructor for SearchOptions.

Method Summary

Modifier and Type	Method	Description
int	depth()	Returns the value of the depth record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	getDepth()	Returns the search depth used when traversing relationships.
List<SearchOperator>	getOperators()	Returns the supported search operators for the field.
final int	hashCode()	Returns a hash code value for this object.
boolean	isSearchable()	Indicates whether the field is searchable.
List<SearchOperator>	operators()	Safe, defensive accessor for operators.
boolean	searchable()	Returns the value of the searchable record component.
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

SearchOptions

public SearchOptions(boolean searchable,
 List<SearchOperator> operators,
 int depth)

Immutable constructor for SearchOptions.

Method Details

isSearchable

public boolean isSearchable()

Indicates whether the field is searchable.

operators

public List<SearchOperator> operators()

Safe, defensive accessor for operators.

getOperators

public List<SearchOperator> getOperators()

Returns the supported search operators for the field.

getDepth

public int getDepth()

Returns the search depth used when traversing relationships.

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

searchable

public boolean searchable()

Returns the value of the searchable record component.

Returns:

the value of the searchable record component

depth

public int depth()

Returns the value of the depth record component.

Returns:

the value of the depth record component