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

Interface FieldMapping

All Known Implementing Classes:
FieldSpec, NoFieldMapping
public sealed interface FieldMapping permits FieldSpec, NoFieldMapping
Defines a mapping of a field or a property in a class to its corresponding representation.

This sealed interface serves as a contract for different types of field or property mappings in the API. It can represent either a specific field or property mapping, or signify the absence of any mapping.

The implementations of this interface are: - FieldSpec: Represents a specification for mapping a particular field or property. - NoFieldMapping: Represents a state where no field mapping is defined.

  • Method Details

    • f

      static FieldSpec f(String field)
      Shortcut for field(String). Creates a new FieldSpec configured for field-level access of the specified field name.
      Parameters:
      field - the name of the field/property in a class
      Returns:
      this FieldSpecBuilder for further chaining

    • field

      static FieldSpec field(String field)
      Creates a new FieldSpec configured for field-level access of the specified field name.
      Parameters:
      field - the name of the field/property in a class
      Returns:
      this FieldSpecBuilder for further chaining

    • p

      static FieldSpec p(String property)
      Shortcut for property(String). Creates a new FieldSpecBuilder configured for property access of the specified property name.
      Parameters:
      property - the name of the property in a class
      Returns:
      this FieldSpecBuilder for further chaining

    • property

      static FieldSpec property(String property)
      Creates a new FieldSpecBuilder configured for property access of the specified property name.
      Parameters:
      property - the name of the property in a class
      Returns:
      this FieldSpecBuilder for further chaining