FontEntity.java

package net.onelitefeather.vulpes.api.model;

import jakarta.persistence.ElementCollection;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import net.onelitefeather.vulpes.api.generator.VulpesGenerator;

import java.util.List;
import java.util.UUID;

/**
 * Represents a Font in the system. This class is used as an entity for persistence
 * with JPA and Micronaut Data. It contains details related to a font such as name,
 * type, ascent, height, etc.
 * <p>
 * This class is mapped to the database table "vulpes_fonts" and contains fields that
 * are automatically persisted by the JPA and Micronaut Data layers.
 * </p>
 */
@Entity(name = "fonts")
public class FontEntity implements VulpesModel {

    @Id
    @GeneratedValue(strategy = GenerationType.UUID)
    @VulpesGenerator
    private UUID id;
    private String uiName;
    private String variableName;
    private String provider;
    private String mapper = "font";
    private String texturePath;
    private String comment;
    private int height;
    private int ascent;
    @ElementCollection
    private List<String> chars;

    /**
     * Default constructor for JPA and Micronaut Data.
     * <p>
     * This constructor is required for the JPA provider to instantiate the entity.
     * </p>
     */
    public FontEntity() {
        // No-argument constructor for JPA
    }

    /**
     * Constructs a new {@link FontEntity} with the specified values.
     *
     * @param id           the unique identifier of the font
     * @param uiName       the user interface name of the font
     * @param variableName the variable name of the font
     * @param provider     the provider of the font
     * @param texturePath  the path to the texture of the font
     * @param height       the height of the font
     * @param ascent       the ascent of the font
     * @param chars        the list of characters included in the font
     */
    public FontEntity(UUID id, String uiName, String variableName, String provider, String texturePath, String comment, int height, int ascent, List<String> chars) {
        this.id = id;
        this.uiName = uiName;
        this.variableName = variableName;
        this.provider = provider;
        this.texturePath = texturePath;
        this.comment = comment;
        this.height = height;
        this.ascent = ascent;
        this.chars = chars;
    }

    // Getters and setters for each field

    /**
     * Returns the unique identifier of the font
     *
     * @return the unique identifier of the font
     */
    public UUID getId() {
        return id;
    }

    /**
     * Sets the unique identifier of the font
     *
     * @param id the unique identifier to set
     */
    public void setId(UUID id) {
        this.id = id;
    }

    public void setUiName(String uiName) {
        this.uiName = uiName;
    }

    public String getUiName() {
        return uiName;
    }

    public void setVariableName(String variableName) {
        this.variableName = variableName;
    }

    public String getVariableName() {
        return variableName;
    }

    public void setMapper(String mapper) {
        this.mapper = mapper;
    }

    public String getMapper() {
        return mapper;
    }

    public void setProvider(String provider) {
        this.provider = provider;
    }

    public String getProvider() {
        return provider;
    }

    public void setTexturePath(String texturePath) {
        this.texturePath = texturePath;
    }

    public String getTexturePath() {
        return texturePath;
    }

    public void setComment(String comment) {
        this.comment = comment;
    }

    public String getComment() {
        return comment;
    }

    /**
     * Returns the ascent of the font
     *
     * @return the ascent of the font
     */
    public int getAscent() {
        return ascent;
    }

    /**
     * Sets the ascent of the font
     *
     * @param ascent the ascent to set
     */
    public void setAscent(int ascent) {
        this.ascent = ascent;
    }

    /**
     * Returns the height of the font
     *
     * @return the height of the font
     */
    public int getHeight() {
        return height;
    }

    /**
     * Sets the height of the font
     *
     * @param height the height to set
     */
    public void setHeight(int height) {
        this.height = height;
    }

    /**
     * Returns the list of characters included in the font
     *
     * @return the list of characters in the font
     */
    public List<String> getChars() {
        return chars;
    }

    /**
     * Sets the list of characters included in the font
     *
     * @param chars the list of characters to set
     */
    public void setChars(List<String> chars) {
        this.chars = chars;
    }

    @Override
    public String toString() {
        return "FontEntity{" +
                "id=" + id +
                ", uiName='" + uiName + '\'' +
                ", variableName='" + variableName + '\'' +
                ", provider='" + provider + '\'' +
                ", mapper='" + mapper + '\'' +
                ", texturePath='" + texturePath + '\'' +
                ", comment='" + comment + '\'' +
                ", height=" + height +
                ", ascent=" + ascent +
                ", chars=" + chars +
                '}';
    }
}