From 9e82a0ac12ff5f8319673f3864e7782eb69c803a Mon Sep 17 00:00:00 2001
From: Suomm <1474983351@qq.com>
Date: Tue, 25 Jul 2023 12:30:43 +0800
Subject: [PATCH] style: add Model javadoc.

---
 .../mybatisflex/core/activerecord/Model.java  | 49 +++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/mybatis-flex-core/src/main/java/com/mybatisflex/core/activerecord/Model.java b/mybatis-flex-core/src/main/java/com/mybatisflex/core/activerecord/Model.java
index e9e46eca..2887bbc2 100644
--- a/mybatis-flex-core/src/main/java/com/mybatisflex/core/activerecord/Model.java
+++ b/mybatis-flex-core/src/main/java/com/mybatisflex/core/activerecord/Model.java
@@ -24,6 +24,8 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * Active Record 模型。
+ *
  * @param <T> 实体类类型
  * @author 王帅
  * @since 2023-07-24
@@ -33,38 +35,85 @@ public abstract class Model<T extends Model<T>>
     extends QueryModel<T>
     implements MapperModel<T> {
 
+    /**
+     * 根据实体类构建的条件删除数据。
+     *
+     * @return {@code true} 删除成功，{@code false} 删除失败
+     */
     public boolean remove() {
         return SqlUtil.toBool(baseMapper().deleteByQuery(getQueryWrapper()));
     }
 
+    /**
+     * 根据实体类构建的条件更新数据（自动忽略 {@code null} 值）。
+     *
+     * @return {@code true} 更新成功，{@code false} 更新失败
+     */
     public boolean update() {
         return update(true);
     }
 
+    /**
+     * 根据实体类构建的条件更新数据，并设置是否忽略 {@code null} 值。
+     *
+     * @param ignoreNulls 是否忽略 {@code null} 值
+     * @return {@code true} 更新成功，{@code false} 更新失败
+     */
     public boolean update(boolean ignoreNulls) {
         return SqlUtil.toBool(baseMapper().updateByQuery((T) this, ignoreNulls, getQueryWrapper()));
     }
 
+    /**
+     * 根据实体类构建的条件查询数据数量。
+     *
+     * @return 数据数量
+     */
     public long count() {
         return baseMapper().selectCountByQuery(getQueryWrapper());
     }
 
+    /**
+     * 根据实体类构建的条件判断数据是否存在。
+     *
+     * @return {@code true} 数据存在，{@code false} 数据不存在
+     */
     public boolean exists() {
         return SqlUtil.toBool(count());
     }
 
+    /**
+     * 根据实体类构建的条件获取一条数据。
+     *
+     * @return 数据
+     */
     public T one() {
         return baseMapper().selectOneByQuery(getQueryWrapper());
     }
 
+    /**
+     * 根据实体类构建的条件获取一条数据，并封装为 {@link Optional} 返回。
+     *
+     * @return 数据
+     */
     public Optional<T> oneOpt() {
         return Optional.ofNullable(one());
     }
 
+    /**
+     * 根据实体类构建的条件获取多条数据。
+     *
+     * @return 数据列表
+     */
     public List<T> list() {
         return baseMapper().selectListByQuery(getQueryWrapper());
     }
 
+    /**
+     * 根据实体类构建的条件获取分页数据。
+     *
+     * @param page 分页对象
+     * @return 分页数据
+     */
     public Page<T> page(Page<T> page) {
         return baseMapper().paginate(page, getQueryWrapper());
     }