Entity (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.core.map.MapWrapper<K,V>
- - org.dromara.hutool.core.map.TransMap<K,V>
  - - org.dromara.hutool.core.map.CustomKeyMap<String,Object>
    - - org.dromara.hutool.core.map.Dict
      - org.dromara.hutool.db.Entity

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Map.Entry<String,Object>>, Map<String,Object>, TypeGetter<String>, Wrapper<Map<String,Object>>

Direct Known Subclasses:

ActiveEntity
```
public class Entity
extends Dict
```
数据实体对象
数据实体类充当两个角色：
1. 数据的载体，一个Entity对应数据库中的一个row
2. SQL条件，Entity中的每一个字段对应一个条件，字段值对应条件的值

Author:

loolly

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Entity.Meta
Entity元数据
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Nested Classes
Modifier and Type	Class and Description
`static class`	`Entity.Meta` Entity元数据

Field Summary
- Fields inherited from class org.dromara.hutool.core.map.Dict
  caseInsensitive

Constructor Summary

Constructors
Constructor and Description
`Entity()` 构造
`Entity(Entity.Meta meta, boolean caseInsensitive)` 构造
`Entity(String tableName)` 构造
`Entity(String tableName, boolean caseInsensitive)` 构造

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Entity`	`addCondition(Condition condition)` 添加条件
`Entity`	`addFieldNames(String... fieldNames)` 添加字段列表
`Entity`	`clone()`
`Entity`	`filterNew(String... keys)` 过滤Map保留指定键值对，如果键不存在跳过
`Blob`	`getBlob(String field)` 获得Blob类型结果，如果结果类型非Blob，不做转换，直接抛出异常
`Clob`	`getClob(String field)` 获得Clob类型结果，如果结果类型非Clob，不做转换，直接抛出异常
`Date`	`getDate(String field, Date defaultValue)` 获取Date类型值
`Set<String>`	`getFieldNames()`
`Entity.Meta`	`getMeta()` 获得元信息
`RowId`	`getRowId()` 获得rowid
`RowId`	`getRowId(String field)` 获得rowid
`Time`	`getSqlTime(String field, Time defaultValue)` 获取LocalTime类型值
`Timestamp`	`getSqlTimestamp(String field, Timestamp defaultValue)` 获取Timestamp类型值
`String`	`getStr(String field, Charset charset, String defaultValue)` 获得字符串值支持Clob、Blob、RowId
`String`	`getStr(String field, String defaultValue)` 获取字符串型属性值若获得的值为不可见字符，使用默认值
`String`	`getTableName()`
`static Entity`	`of()` 创建Entity
`static Entity`	`of(String tableName)` 创建Entity
`static <T> Entity`	`of(T bean)` 将PO对象转为Entity
`static <T> Entity`	`of(T bean, boolean isToUnderlineCase, boolean ignoreNullValue)` 将PO对象转为Entity
`static <T> Entity`	`ofWithUnderlineCase(T bean)` 将PO对象转为Entity,并采用下划线法转换字段
`<T> Entity`	`parseBean(T bean)` 将值对象转换为Entity 类名会被当作表名，小写第一个字母
`<T> Entity`	`parseBean(T bean, boolean isToUnderlineCase, boolean ignoreNullValue)` 将值对象转换为Entity 类名会被当作表名，小写第一个字母
`Entity`	`removeNew(String... keys)` 过滤Map去除指定键值对，如果键不存在跳过
`Entity`	`set(String field, Object value)` 设置列
`Entity`	`setFieldNames(Iterable<String> fieldNames)` 设置字段列表，用于限制加入的字段的值
`Entity`	`setFieldNames(String... fieldNames)` 设置字段列表，用于限制加入的字段的值
`Entity`	`setFields(SerSupplier<?>... fields)` 通过lambda批量设置值
`Entity`	`setIgnoreNull(String field, Object value)` 设置列，当键或值为null时忽略
`Entity`	`setMeta(Entity.Meta meta)` 设置元信息
`Entity`	`setTableName(String tableName)` 设置表名
`String`	`toString()`

Methods inherited from class org.dromara.hutool.core.map.Dict
customKey, get, getBean, getByPath, getByPath, getObj, ofEntries, ofKvs, parse, removeEqual, toBean, toBean, toBeanIgnoreCase, toBeanIgnoreCase

Methods inherited from class org.dromara.hutool.core.map.CustomKeyMap
customValue

Methods inherited from class org.dromara.hutool.core.map.TransMap
compute, computeIfAbsent, computeIfPresent, containsKey, get, getOrDefault, merge, put, putAll, putIfAbsent, remove, remove, replace, replace

Methods inherited from class org.dromara.hutool.core.map.MapWrapper
clear, containsValue, entrySet, equals, forEach, getRaw, hashCode, isEmpty, iterator, keySet, replaceAll, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dromara.hutool.core.lang.getter.TypeGetter
get, get, get, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBool, getBool, getByte, getByte, getBytes, getBytes, getChar, getChar, getDate, getDouble, getDouble, getEnum, getEnum, getFloat, getFloat, getInt, getInt, getLocalDate, getLocalDate, getLocalDateTime, getLocalDateTime, getLocalTime, getLocalTime, getLong, getLong, getNumber, getNumber, getObj, getShort, getShort, getSqlTime, getSqlTimestamp, getStr

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Entity
```
public Entity()
```
    构造
  - Entity
```
public Entity(String tableName)
```
    构造
    
    Parameters:
    
    tableName - 数据表名
  - Entity
```
public Entity(String tableName,
              boolean caseInsensitive)
```
    构造
    
    Parameters:
    
    tableName - 数据表名
    
    caseInsensitive - 是否大小写不敏感
    
    Since:
    
    4.5.16
  - Entity
```
public Entity(Entity.Meta meta,
              boolean caseInsensitive)
```
    构造
    
    Parameters:
    
    meta - 元信息
    
    caseInsensitive - 是否大小写不敏感
- Method Detail
  - of
```
public static Entity of()
```
    创建Entity
    
    Returns:
    
    Entity
  - of
```
public static Entity of(String tableName)
```
    创建Entity
    
    Parameters:
    
    tableName - 表名
    
    Returns:
    
    Entity
  - ofWithUnderlineCase
```
public static <T> Entity ofWithUnderlineCase(T bean)
```
    将PO对象转为Entity,并采用下划线法转换字段
    
    Type Parameters:
    
    T - Bean对象类型
    
    Parameters:
    
    bean - Bean对象
    
    Returns:
    
    Entity
  - of
```
public static <T> Entity of(T bean)
```
    将PO对象转为Entity
    
    Type Parameters:
    
    T - Bean对象类型
    
    Parameters:
    
    bean - Bean对象
    
    Returns:
    
    Entity
  - of
```
public static <T> Entity of(T bean,
                            boolean isToUnderlineCase,
                            boolean ignoreNullValue)
```
    将PO对象转为Entity
    
    Type Parameters:
    
    T - Bean对象类型
    
    Parameters:
    
    bean - Bean对象
    
    isToUnderlineCase - 是否转换为下划线模式
    
    ignoreNullValue - 是否忽略值为空的字段
    
    Returns:
    
    Entity
  - getMeta
```
public Entity.Meta getMeta()
```
    获得元信息
    
    Returns:
    
    元信息
  - setMeta
```
public Entity setMeta(Entity.Meta meta)
```
    设置元信息
    
    Parameters:
    
    meta - 元信息
    
    Returns:
    
    本身
  - getTableName
```
public String getTableName()
```
    Returns:
    
    获得表名
  - setTableName
```
public Entity setTableName(String tableName)
```
    设置表名
    
    Parameters:
    
    tableName - 表名
    
    Returns:
    
    本身
  - getFieldNames
```
public Set<String> getFieldNames()
```
    Returns:
    
    字段集合
  - setFieldNames
```
public Entity setFieldNames(Iterable<String> fieldNames)
```
    设置字段列表，用于限制加入的字段的值
    
    Parameters:
    
    fieldNames - 字段列表
    
    Returns:
    
    自身
  - setFieldNames
```
public Entity setFieldNames(String... fieldNames)
```
    设置字段列表，用于限制加入的字段的值
    
    Parameters:
    
    fieldNames - 字段列表
    
    Returns:
    
    自身
  - setFields
```
public Entity setFields(SerSupplier<?>... fields)
```
    通过lambda批量设置值
    
    Overrides:
    
    setFields in class Dict
    
    Parameters:
    
    fields - lambda,不能为空
    
    Returns:
    
    this
  - addFieldNames
```
public Entity addFieldNames(String... fieldNames)
```
    添加字段列表
    
    Parameters:
    
    fieldNames - 字段列表
    
    Returns:
    
    自身
  - parseBean
```
public <T> Entity parseBean(T bean)
```
    将值对象转换为Entity
    类名会被当作表名，小写第一个字母
    
    Overrides:
    
    parseBean in class Dict
    
    Type Parameters:
    
    T - Bean对象类型
    
    Parameters:
    
    bean - Bean对象
    
    Returns:
    
    自己
  - parseBean
```
public <T> Entity parseBean(T bean,
                            boolean isToUnderlineCase,
                            boolean ignoreNullValue)
```
    将值对象转换为Entity
    类名会被当作表名，小写第一个字母
    
    Overrides:
    
    parseBean in class Dict
    
    Type Parameters:
    
    T - Bean对象类型
    
    Parameters:
    
    bean - Bean对象
    
    isToUnderlineCase - 是否转换为下划线模式
    
    ignoreNullValue - 是否忽略值为空的字段
    
    Returns:
    
    自己
  - filterNew
```
public Entity filterNew(String... keys)
```
    过滤Map保留指定键值对，如果键不存在跳过
    
    Overrides:
    
    filterNew in class Dict
    
    Parameters:
    
    keys - 键列表
    
    Returns:
    
    Dict 结果
    
    Since:
    
    4.0.10
  - removeNew
```
public Entity removeNew(String... keys)
```
    Description copied from class: Dict
    
    过滤Map去除指定键值对，如果键不存在跳过
    
    Overrides:
    
    removeNew in class Dict
    
    Parameters:
    
    keys - 键列表
    
    Returns:
    
    Dict 结果
  - addCondition
```
public Entity addCondition(Condition condition)
```
    添加条件
    
    Parameters:
    
    condition - 条件
    
    Returns:
    
    this
  - set
```
public Entity set(String field,
                  Object value)
```
    Description copied from class: Dict
    
    设置列
    
    Overrides:
    
    set in class Dict
    
    Parameters:
    
    field - 属性
    
    value - 值
    
    Returns:
    
    本身
  - setIgnoreNull
```
public Entity setIgnoreNull(String field,
                            Object value)
```
    Description copied from class: Dict
    
    设置列，当键或值为null时忽略
    
    Overrides:
    
    setIgnoreNull in class Dict
    
    Parameters:
    
    field - 属性
    
    value - 值
    
    Returns:
    
    本身
  - getClob
```
public Clob getClob(String field)
```
    获得Clob类型结果，如果结果类型非Clob，不做转换，直接抛出异常
    
    Parameters:
    
    field - 参数
    
    Returns:
    
    Clob
  - getBlob
```
public Blob getBlob(String field)
```
    获得Blob类型结果，如果结果类型非Blob，不做转换，直接抛出异常
    
    Parameters:
    
    field - 参数
    
    Returns:
    
    Blob
    
    Since:
    
    3.0.6
  - getSqlTime
```
public Time getSqlTime(String field,
                       Time defaultValue)
```
    Description copied from interface: TypeGetter
    
    获取LocalTime类型值
    
    Parameters:
    
    field - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    LocalTime类型属性值
  - getDate
```
public Date getDate(String field,
                    Date defaultValue)
```
    Description copied from interface: TypeGetter
    
    获取Date类型值
    
    Parameters:
    
    field - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    Date类型属性值
  - getSqlTimestamp
```
public Timestamp getSqlTimestamp(String field,
                                 Timestamp defaultValue)
```
    Description copied from interface: TypeGetter
    
    获取Timestamp类型值
    
    Parameters:
    
    field - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    Timestamp类型属性值
  - getStr
```
public String getStr(String field,
                     String defaultValue)
```
    Description copied from interface: TypeGetter
    
    获取字符串型属性值
    若获得的值为不可见字符，使用默认值
    
    Parameters:
    
    field - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值，无对应值返回defaultValue
  - getStr
```
public String getStr(String field,
                     Charset charset,
                     String defaultValue)
```
    获得字符串值
    支持Clob、Blob、RowId
    
    Parameters:
    
    field - 字段名
    
    charset - 编码
    
    defaultValue - 默认值
    
    Returns:
    
    字段对应值
  - getRowId
```
public RowId getRowId()
```
    获得rowid
    
    Returns:
    
    RowId
  - getRowId
```
public RowId getRowId(String field)
```
    获得rowid
    
    Parameters:
    
    field - rowid属性名
    
    Returns:
    
    RowId
  - clone
```
public Entity clone()
```
    Overrides:
    
    clone in class Dict
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class MapWrapper<String,Object>

Class Entity

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class org.dromara.hutool.core.map.Dict

Constructor Summary

Method Summary

Methods inherited from class org.dromara.hutool.core.map.Dict

Methods inherited from class org.dromara.hutool.core.map.CustomKeyMap

Methods inherited from class org.dromara.hutool.core.map.TransMap

Methods inherited from class org.dromara.hutool.core.map.MapWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface org.dromara.hutool.core.lang.getter.TypeGetter

Methods inherited from interface java.lang.Iterable

Constructor Detail

Entity

Entity

Entity

Entity

Method Detail

of

of

ofWithUnderlineCase

of

of

getMeta

setMeta

getTableName

setTableName

getFieldNames

setFieldNames

setFieldNames

setFields

addFieldNames

parseBean

parseBean

filterNew

removeNew

addCondition

set

setIgnoreNull

getClob

getBlob

getSqlTime

getDate

getSqlTimestamp

getStr

getStr

getRowId

getRowId

clone

toString