Package overit.geocall.edm.model

Record Class IndexCreationParameters

java.lang.Object

java.lang.Record

overit.geocall.edm.model.IndexCreationParameters

public record IndexCreationParameters(Long id, @NotNull String realName, String description, boolean unique, boolean addReverse, @NotEmpty List<BaseDataAttribute> fields, @NotNull IndexCreationStatus status)
extends Record

Record about the parameters necessary to create an Index.

Constructor Summary

Constructors

Constructor	Description
IndexCreationParameters(Long id, @NotNull String realName, String description, boolean unique, boolean addReverse, @NotEmpty List<BaseDataAttribute> fields, @NotNull IndexCreationStatus status)	Creates and returns a new IndexCreationParameters instance using the provided parameters.

Method Summary

Modifier and Type	Method	Description
boolean	addReverse()	Returns the value of the addReverse record component.
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotEmpty List<BaseDataAttribute>	fields()	Returns the value of the fields record component.
final int	hashCode()	Returns a hash code value for this object.
Long	id()	Returns the value of the id record component.
@NotNull String	realName()	Returns the value of the realName record component.
@NotNull IndexCreationStatus	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.
boolean	unique()	Returns the value of the unique record component.

Methods inherited from class java.lang.Object

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

Constructor Details

IndexCreationParameters

public IndexCreationParameters(Long id,
 @NotNull
 @NotNull String realName,
 String description,
 boolean unique,
 boolean addReverse,
 @NotEmpty
 @NotEmpty List<BaseDataAttribute> fields,
 @NotNull
 @NotNull IndexCreationStatus status)

Creates and returns a new IndexCreationParameters instance using the provided parameters.

Parameters:

id - Long about the ID of the index.

realName - String about the real name of the index.

description - String about the description of the index.

unique - boolean about whether this index enforces uniqueness constraint.

addReverse - boolean about whether the index should also be added in reverse order.

fields - List<BaseDataAttribute> (fields) that are part of this index.

status - IndexCreationStatus about the status of this index.

Method Details

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.

id

public Long id()

Returns the value of the id record component.

Returns:

the value of the id record component

realName

@NotNull
public @NotNull String realName()

Returns the value of the realName record component.

Returns:

the value of the realName record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

unique

public boolean unique()

Returns the value of the unique record component.

Returns:

the value of the unique record component

addReverse

public boolean addReverse()

Returns the value of the addReverse record component.

Returns:

the value of the addReverse record component

fields

@NotEmpty
public @NotEmpty List<BaseDataAttribute> fields()

Returns the value of the fields record component.

Returns:

the value of the fields record component

status

@NotNull
public @NotNull IndexCreationStatus status()

Returns the value of the status record component.

Returns:

the value of the status record component