Entity (hutool 5.8.33 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<K,V>
  - - java.util.LinkedHashMap<String,Object>
    - - cn.hutool.core.lang.Dict
      - cn.hutool.db.Entity

All Implemented Interfaces:

BasicTypeGetter<String>, Serializable, Cloneable, 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/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors
Constructor and Description

Entity()

Entity(String tableName)
构造

Entity(String tableName, boolean caseInsensitive)
构造

Constructors
Constructor and Description
`Entity()`
`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`	`addFieldNames(String... fieldNames)` 添加字段列表
`Entity`	`clone()`
`static Entity`	`create()` 创建Entity
`static Entity`	`create(String tableName)` 创建Entity
`Entity`	`filter(String... keys)` 过滤Map保留指定键值对，如果键不存在跳过
`Blob`	`getBlob(String field)` 获得Blob类型结果
`Clob`	`getClob(String field)` 获得Clob类型结果
`Date`	`getDate(String field)` 获取Date类型值
`Set<String>`	`getFieldNames()`
`RowId`	`getRowId()` 获得rowid
`RowId`	`getRowId(String field)` 获得rowid
`String`	`getStr(String field)` 获取字符串型属性值
`String`	`getStr(String field, Charset charset)` 获得字符串值支持Clob、Blob、RowId
`String`	`getTableName()`
`Time`	`getTime(String field)`
`Timestamp`	`getTimestamp(String field)`
`static <T> Entity`	`parse(T bean)` 将PO对象转为Entity
`static <T> Entity`	`parse(T bean, boolean isToUnderlineCase, boolean ignoreNullValue)` 将PO对象转为Entity
`<T> Entity`	`parseBean(T bean)` 将值对象转换为Entity 类名会被当作表名，小写第一个字母
`<T> Entity`	`parseBean(T bean, boolean isToUnderlineCase, boolean ignoreNullValue)` 将值对象转换为Entity 类名会被当作表名，小写第一个字母
`static <T> Entity`	`parseWithUnderlineCase(T bean)` 将PO对象转为Entity,并采用下划线法转换字段
`Entity`	`removeNew(String... keys)` 过滤Map去除指定键值对，如果键不存在跳过
`Entity`	`set(String field, Object value)` 设置列
`Entity`	`setFieldNames(Collection<String> fieldNames)` 设置字段列表，用于限制加入的字段的值
`Entity`	`setFieldNames(String... fieldNames)` 设置字段列表，用于限制加入的字段的值
`Entity`	`setFields(Func0<?>... fields)` 通过lambda批量设置值
`Entity`	`setIgnoreNull(String field, Object value)` 设置列，当键或值为null时忽略
`Entity`	`setTableName(String tableName)` 设置表名
`String`	`toString()`

Methods inherited from class cn.hutool.core.lang.Dict
compute, computeIfAbsent, computeIfPresent, containsKey, get, get, getBean, getBigDecimal, getBigInteger, getBool, getByPath, getByPath, getByte, getBytes, getChar, getDouble, getEnum, getFloat, getInt, getLong, getNumber, getObj, getOrDefault, getShort, merge, of, of, put, putAll, putIfAbsent, remove, remove, removeEqual, replace, replace, toBean, toBean, toBean, toBeanIgnoreCase, toBeanIgnoreCase, toBeanWithCamelCase

Methods inherited from class java.util.LinkedHashMap
clear, containsValue, entrySet, forEach, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap
isEmpty, size

Methods inherited from class java.util.AbstractMap
equals, hashCode

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

Methods inherited from interface java.util.Map
equals, hashCode, isEmpty, size

- 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
- Method Detail
  - create
```
public static Entity create()
```
    创建Entity
    
    Returns:
    
    Entity
  - create
```
public static Entity create(String tableName)
```
    创建Entity
    
    Parameters:
    
    tableName - 表名
    
    Returns:
    
    Entity
  - parse
```
public static <T> Entity parse(T bean)
```
    将PO对象转为Entity
    
    Type Parameters:
    
    T - Bean对象类型
    
    Parameters:
    
    bean - Bean对象
    
    Returns:
    
    Entity
  - parse
```
public static <T> Entity parse(T bean,
                               boolean isToUnderlineCase,
                               boolean ignoreNullValue)
```
    将PO对象转为Entity
    
    Type Parameters:
    
    T - Bean对象类型
    
    Parameters:
    
    bean - Bean对象
    
    isToUnderlineCase - 是否转换为下划线模式
    
    ignoreNullValue - 是否忽略值为空的字段
    
    Returns:
    
    Entity
  - parseWithUnderlineCase
```
public static <T> Entity parseWithUnderlineCase(T bean)
```
    将PO对象转为Entity,并采用下划线法转换字段
    
    Type Parameters:
    
    T - Bean对象类型
    
    Parameters:
    
    bean - Bean对象
    
    Returns:
    
    Entity
  - getTableName
```
public String getTableName()
```
    Returns:
    
    获得表名
  - setTableName
```
public Entity setTableName(String tableName)
```
    设置表名
    
    Parameters:
    
    tableName - 表名
    
    Returns:
    
    本身
  - getFieldNames
```
public Set<String> getFieldNames()
```
    Returns:
    
    字段集合
  - setFieldNames
```
public Entity setFieldNames(Collection<String> fieldNames)
```
    设置字段列表，用于限制加入的字段的值
    
    Parameters:
    
    fieldNames - 字段列表
    
    Returns:
    
    自身
  - setFieldNames
```
public Entity setFieldNames(String... fieldNames)
```
    设置字段列表，用于限制加入的字段的值
    
    Parameters:
    
    fieldNames - 字段列表
    
    Returns:
    
    自身
  - setFields
```
public Entity setFields(Func0<?>... 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:
    
    自己
  - filter
```
public Entity filter(String... keys)
```
    过滤Map保留指定键值对，如果键不存在跳过
    
    Overrides:
    
    filter in class Dict
    
    Parameters:
    
    keys - 键列表
    
    Returns:
    
    Dict 结果
    
    Since:
    
    4.0.10
  - removeNew
```
public Entity removeNew(String... keys)
```
    过滤Map去除指定键值对，如果键不存在跳过
    
    Parameters:
    
    keys - 键列表
    
    Returns:
    
    Dict 结果
    
    Since:
    
    5.8.19
  - 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类型结果
    
    Parameters:
    
    field - 参数
    
    Returns:
    
    Clob
  - getBlob
```
public Blob getBlob(String field)
```
    获得Blob类型结果
    
    Parameters:
    
    field - 参数
    
    Returns:
    
    Blob
    
    Since:
    
    3.0.6
  - getTime
```
public Time getTime(String field)
```
    Overrides:
    
    getTime in class Dict
    
    Parameters:
    
    field - 字段名
    
    Returns:
    
    字段值
  - getDate
```
public Date getDate(String field)
```
    Description copied from interface: BasicTypeGetter
    
    获取Date类型值
    
    Specified by:
    
    getDate in interface BasicTypeGetter<String>
    
    Overrides:
    
    getDate in class Dict
    
    Parameters:
    
    field - 字段名
    
    Returns:
    
    字段值
  - getTimestamp
```
public Timestamp getTimestamp(String field)
```
    Overrides:
    
    getTimestamp in class Dict
    
    Parameters:
    
    field - 字段名
    
    Returns:
    
    字段值
  - getStr
```
public String getStr(String field)
```
    Description copied from interface: BasicTypeGetter
    
    获取字符串型属性值
    
    Specified by:
    
    getStr in interface BasicTypeGetter<String>
    
    Overrides:
    
    getStr in class Dict
    
    Parameters:
    
    field - 字段名
    
    Returns:
    
    字段值
  - getStr
```
public String getStr(String field,
                     Charset charset)
```
    获得字符串值
    支持Clob、Blob、RowId
    
    Parameters:
    
    field - 字段名
    
    charset - 编码
    
    Returns:
    
    字段对应值
    
    Since:
    
    3.0.6
  - 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 AbstractMap<String,Object>

Class Entity

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Constructor Summary

Method Summary

Methods inherited from class cn.hutool.core.lang.Dict

Methods inherited from class java.util.LinkedHashMap

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Entity

Entity

Entity

Method Detail

create

create

parse

parse

parseWithUnderlineCase

getTableName

setTableName

getFieldNames

setFieldNames

setFieldNames

setFields

addFieldNames

parseBean

parseBean

filter

removeNew

set

setIgnoreNull

getClob

getBlob

getTime

getDate

getTimestamp

getStr

getStr

getRowId

getRowId

clone

toString