Module litebridge.orm
Package org.litebridgedb.orm.api.spec

Record Class FieldSpec

java.lang.Object
java.lang.Record
org.litebridgedb.orm.api.spec.FieldSpec
Record Components:
dtoClass - The class of the DTO to which the field belongs.
name - The name of the field or property to be mapped.
property - Indicates whether property-level access is enabled. true signifies property-based access (via getter/setter), and false signifies direct field access.
All Implemented Interfaces:
FieldMapping
public record FieldSpec(@Nullable Class<?> dtoClass, String name, boolean property) extends Record implements FieldMapping
Represents a specification for mapping a field in a class to a database column or property.

This class is part of the ORM specification for defining how fields or properties in a DTO (Data Transfer Object) are mapped to their corresponding database representations.

A FieldSpec can represent a field-level or property-level access based on the property flag. Field-level access considers the field name directly for mapping, whereas property-level access assumes usage of getter/setter conventions.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FieldSpec(@Nullable Class<?> dtoClass, String name, boolean property)
    Creates an instance of a FieldSpec record class.
    FieldSpec(String name, boolean property)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Class<?>
    dtoClass()
    Returns the value of the dtoClass 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
    name()
    Returns the value of the name record component.
    boolean
    property()
    Returns the value of the property 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

    • FieldSpec

      public FieldSpec(String name, boolean property)

    • FieldSpec

      public FieldSpec(@Nullable Class<?> dtoClass, String name, boolean property)
      Creates an instance of a FieldSpec record class.
      Parameters:
      dtoClass - the value for the dtoClass record component
      name - the value for the name record component
      property - the value for the property 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.

    • dtoClass

      public @Nullable Class<?> dtoClass()
      Returns the value of the dtoClass record component.
      Returns:
      the value of the dtoClass record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • property

      public boolean property()
      Returns the value of the property record component.
      Returns:
      the value of the property record component