Package io.jmix.datatools.datamodel

Record Class AttributeDescriptor

java.lang.Object

java.lang.Record

io.jmix.datatools.datamodel.AttributeDescriptor

Record Components:

name - attribute name

javaType - displayed Java type

mandatory - whether a value is required

dynamic - whether the attribute is defined at runtime rather than on the classpath

column - physical column, or null when the attribute has no column of its own

noColumnText - text shown in place of a column name when column is null

relation - relation to another entity, or null when the attribute is not a reference

@NullMarked
public record AttributeDescriptor(String name, String javaType, boolean mandatory, boolean dynamic, @Nullable AttributeDescriptor.ColumnDescriptor column, @Nullable String noColumnText, @Nullable AttributeDescriptor.RelationDescriptor relation)
extends Record

Description of an attribute contributed to the data model.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AttributeDescriptor.ColumnDescriptor	Physical column of a contributed attribute.
static final record	AttributeDescriptor.RelationDescriptor	Relation declared by a contributed attribute.

Constructor Summary

Constructors

Constructor	Description
AttributeDescriptor(String name, String javaType, boolean mandatory, boolean dynamic, @Nullable AttributeDescriptor.ColumnDescriptor column, @Nullable String noColumnText, @Nullable AttributeDescriptor.RelationDescriptor relation)	Creates an instance of a AttributeDescriptor record class.

Method Summary

Modifier and Type	Method	Description
@Nullable AttributeDescriptor.ColumnDescriptor	column()	Returns the value of the column record component.
boolean	dynamic()	Returns the value of the dynamic record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	javaType()	Returns the value of the javaType record component.
boolean	mandatory()	Returns the value of the mandatory record component.
String	name()	Returns the value of the name record component.
@Nullable String	noColumnText()	Returns the value of the noColumnText record component.
@Nullable AttributeDescriptor.RelationDescriptor	relation()	Returns the value of the relation 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

AttributeDescriptor

public AttributeDescriptor(String name,
 String javaType,
 boolean mandatory,
 boolean dynamic,
 @Nullable AttributeDescriptor.ColumnDescriptor column,
 @Nullable String noColumnText,
 @Nullable AttributeDescriptor.RelationDescriptor relation)

Creates an instance of a AttributeDescriptor record class.

Parameters:

name - the value for the name record component

javaType - the value for the javaType record component

mandatory - the value for the mandatory record component

dynamic - the value for the dynamic record component

column - the value for the column record component

noColumnText - the value for the noColumnText record component

relation - the value for the relation record component

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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

javaType

public String javaType()

Returns the value of the javaType record component.

Returns:

the value of the javaType record component

mandatory

public boolean mandatory()

Returns the value of the mandatory record component.

Returns:

the value of the mandatory record component

dynamic

public boolean dynamic()

Returns the value of the dynamic record component.

Returns:

the value of the dynamic record component

column

public @Nullable AttributeDescriptor.ColumnDescriptor column()

Returns the value of the column record component.

Returns:

the value of the column record component

noColumnText

public @Nullable String noColumnText()

Returns the value of the noColumnText record component.

Returns:

the value of the noColumnText record component

relation

public @Nullable AttributeDescriptor.RelationDescriptor relation()

Returns the value of the relation record component.

Returns:

the value of the relation record component